diff --git a/CMakeLists.txt b/CMakeLists.txt index 64292ec..ea7be08 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,12 +6,4 @@ set(COMPONENT_ADD_INCLUDEDIRS "src" ) -set(COMPONENT_REQUIRES - "arduino-esp32" - "AsyncTCP" -) - register_component() - -target_compile_definitions(${COMPONENT_TARGET} PUBLIC -DESP32) -target_compile_options(${COMPONENT_TARGET} PRIVATE -fno-rtti) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 0a5f914..4fcdc2f 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -6,7 +6,7 @@ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, +identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation. diff --git a/README.md b/README.md index d8406df..92fec33 100644 --- a/README.md +++ b/README.md @@ -8,108 +8,71 @@ [![License: LGPL 3.0](https://img.shields.io/badge/License-LGPL%203.0-yellow.svg)](https://opensource.org/license/lgpl-3-0/) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) -[![Build](https://github.com/ESP32Async/ESPAsyncWebServer/actions/workflows/ci.yml/badge.svg)](https://github.com/ESP32Async/ESPAsyncWebServer/actions/workflows/ci.yml) [![GitHub latest commit](https://badgen.net/github/last-commit/ESP32Async/ESPAsyncWebServer)](https://GitHub.com/ESP32Async/ESPAsyncWebServer/commit/) [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ESP32Async/ESPAsyncWebServer) -Project moved to [ESP32Async](https://github.com/organizations/ESP32Async) organization at [https://github.com/ESP32Async/ESPAsyncWebServer](https://github.com/ESP32Async/ESPAsyncWebServer) +[![ESP32Async Discord Server](https://img.shields.io/badge/Discord-ESP32Async-blue?logo=discord)](https://discord.gg/X7zpGdyUcY) -Discord Server: [https://discord.gg/X7zpGdyUcY](https://discord.gg/X7zpGdyUcY) +[![Documentation](https://img.shields.io/badge/Wiki-ESPAsyncWebServer-blue?logo=github)](https://github.com/ESP32Async/ESPAsyncWebServer/wiki) -Please see the new links: +## Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266, RP2040 and RP2350 -- `ESP32Async/ESPAsyncWebServer @ 3.6.0` (ESP32, ESP8266, RP2040) -- `ESP32Async/AsyncTCP @ 3.3.2` (ESP32) -- `ESP32Async/ESPAsyncTCP @ 2.0.0` (ESP8266) -- `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` (AsyncTCP alternative for ESP32) -- `khoih-prog/AsyncTCP_RP2040W @ 1.2.0` (RP2040) - -Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266 and RP2040 Supports: WebSocket, SSE, Authentication, Arduino Json 7, File Upload, Static File serving, URL Rewrite, URL Redirect, etc. -- [Changes in this repository](#changes-in-this-repository) +- [Documentation](#documentation) +- [How to install](#how-to-install) - [Dependencies](#dependencies) -- [Performance](#performance) -- [Important recommendations for build options](#important-recommendations-for-build-options) -- [`AsyncWebSocketMessageBuffer` and `makeBuffer()`](#asyncwebsocketmessagebuffer-and-makebuffer) -- [How to replace a response](#how-to-replace-a-response) -- [How to use Middleware](#how-to-use-middleware) -- [How to use authentication with AsyncAuthenticationMiddleware](#how-to-use-authentication-with-authenticationmiddleware) -- [Migration to Middleware to improve performance and memory usage](#migration-to-middleware-to-improve-performance-and-memory-usage) -- [Original Documentation](#original-documentation) + - [ESP32 / pioarduino](#esp32--pioarduino) + - [ESP8266 / pioarduino](#esp8266--pioarduino) + - [Unofficial dependencies](#unofficial-dependencies) -## Changes in this repository +## Documentation -- (bug) A lot of bug fixes -- (ci) Better CI with a complete matrix of Arduino versions and boards -- (ci) Deployed in PlatformIO registry and Arduino IDE library manager -- (feat) **Arduino 3 / ESP-IDF 5** compatibility -- (feat) **ArduinoJson 7** compatibility -- (feat) **ESP32 / ESP8266 / RP2040** support -- (feat) **MessagePack** support -- (feat) **Middleware** support with pre-built middlewares for authentication, authorization, rate limiting, logging, cors, etc. -- (feat) **Request attributes** to store data on the request object -- (feat) **Response header** control and override -- (feat) **Response override**: support the ability to replace a previously sent response by another one -- (feat) **Resumable download** support using HEAD and bytes range -- (feat) `StreamConcat` example to show how to stream multiple files in one response -- (feat) Removed ESPIDF Editor (this is not the role of a web server library to do that - get the source files from the original repos if required) -- (perf) [AsyncTCPSock](https://github.com/ESP32Async/AsyncTCPSock) support: AsyncTCP can be ignored and AsyncTCPSock used instead -- (perf) `char*` overloads to avoid using `String` -- (perf) `DEFAULT_MAX_WS_CLIENTS` to change the number of allows WebSocket clients and use `cleanupClients()` to help cleanup resources about dead clients -- (perf) `setCloseClientOnQueueFull(bool)` which can be set on a client to either close the connection or discard messages but not close the connection when the queue is full -- (perf) `SSE_MAX_QUEUED_MESSAGES` to control the maximum number of messages that can be queued for a SSE client -- (perf) `WS_MAX_QUEUED_MESSAGES`: control the maximum number of messages that can be queued for a Websocket client -- (perf) in-flight buffer control and queue congestion avoidance to help to improve parallel connections handling, high volume data transfers and mitigate poor implemeneted slow user-code callbacks delayes on connctions handling -- (perf) Code size improvements -- (perf) Lot of code cleanup and optimizations -- (perf) Performance improvements in terms of memory, speed and size +The complete [project documentation](https://github.com/ESP32Async/ESPAsyncWebServer/wiki) is available in the Wiki section. ---- +## How to install -## WARNING: Important notes about future version 4.x +The library can be downloaded from the releases page at [https://github.com/ESP32Async/ESPAsyncWebServer/releases](https://github.com/ESP32Async/ESPAsyncWebServer/releases). -This ESPAsyncWebServer fork is now at version 3.x, where we try to keep the API compatibility with original project as much as possible. +It is also deployed in these registries: -We plan on creating a next major 4.x version that will: +- Arduino Library Registry: [https://github.com/arduino/library-registry](https://github.com/arduino/library-registry) -1. Drop support for ESP8266, which goes EOL in a few years -2. Drop support for Arduino 2.x and ESP-IDF 4.x. The library will be compatible with latest Arduino and ESP-IDF -3. Drop support for ArduinoJson 5.x and 6.x. The library will be compatible with latest ArduinoJson +- ESP Component Registry [https://components.espressif.com/components/esp32async/espasyncbebserver/](https://components.espressif.com/components/esp32async/espasyncbebserver/) -So if you need one of these feature, you will have to stick with the current 3.x. -All releases we do will not cease to exist: all 3.x releases will stay in the release page. -That is why we have tags and a release cycle. +- PlatformIO Registry: [https://registry.platformio.org/libraries/esp32async/ESPAsyncWebServer](https://registry.platformio.org/libraries/esp32async/ESPAsyncWebServer) -Maintaining a library for ESP8266 and RP2040 has a real cost and clearly what we see is that most users helping are on ESP32. - -If you are an ESP8266 user and want to help improve current 3.x, you are more than welcomed to contribute to this community effort. + - Use: `lib_deps=ESP32Async/ESPAsyncWebServer` to point to latest version + - Use: `lib_deps=ESP32Async/ESPAsyncWebServer @ ^` to point to latest version with the same major version + - Use: `lib_deps=ESP32Async/ESPAsyncWebServer @ ` to always point to the same version (reproductible build) ## Dependencies -> [!WARNING] -> The library name was changed from `ESP Async WebServer` to `ESPAsyncWebServer` as per the Arduino Lint recommendations, but its name had to stay `ESP Async WebServer` in Arduino Registry. - -**PlatformIO / pioarduino:** +### ESP32 / pioarduino ```ini +[env:stable] +platform = https://github.com/pioarduino/platform-espressif32/releases/download/stable/platform-espressif32.zip lib_compat_mode = strict lib_ldf_mode = chain -lib_deps = ESP32Async/ESPAsyncWebServer @ 3.6.0 +lib_deps = + ESP32Async/AsyncTCP + ESP32Async/ESPAsyncWebServer ``` -**Dependencies:** +### ESP8266 / pioarduino -- **ESP32 with AsyncTCP**: `ESP32Async/AsyncTCP @ 3.3.2` - Arduino IDE: [https://github.com/ESP32Async/AsyncTCP#v3.3.2](https://github.com/ESP32Async/AsyncTCP/releases) +```ini +[env:stable] +platform = espressif8266 +lib_compat_mode = strict +lib_ldf_mode = chain +lib_deps = + ESP32Async/ESPAsyncTCP + ESP32Async/ESPAsyncWebServer +``` -- **ESP32 with AsyncTCPSock**: `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip` - -- **ESP8266**: `ESP32Async/ESPAsyncTCP @ 2.0.0` - Arduino IDE: [https://github.com/ESP32Async/ESPAsyncTCP#v2.0.0](https://github.com/ESP32Async/ESPAsyncTCP/releases/tag/v2.0.0) - -- **RP2040**: `khoih-prog/AsyncTCP_RP2040W @ 1.2.0` - Arduino IDE: [https://github.com/khoih-prog/AsyncTCP_RP2040W#v1.2.0](https://github.com/khoih-prog/AsyncTCP_RP2040W/releases/tag/v1.2.0) +### Unofficial dependencies **AsyncTCPSock** @@ -119,63 +82,30 @@ AsyncTCPSock can be used instead of AsyncTCP by excluding AsyncTCP from the libr lib_compat_mode = strict lib_ldf_mode = chain lib_deps = - ; ESP32Async/AsyncTCP @ 3.3.2 https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip - ESP32Async/ESPAsyncWebServer @ 3.6.0 + ESP32Async/ESPAsyncWebServer lib_ignore = AsyncTCP ESP32Async/AsyncTCP ``` -## Performance +**RPAsyncTCP** -Performance of `ESP32Async/ESPAsyncWebServer @ 3.6.0`: +RPAsyncTCP replaces AsyncTCP to provide support for RP2040(+WiFi) and RP2350(+WiFi) boards. For example - Raspberry Pi Pico W and Raspberry Pi Pico 2W. -```bash -> brew install autocannon -> autocannon -c 10 -w 10 -d 20 http://192.168.4.1 -``` - -With `ESP32Async/AsyncTCP @ 3.3.2` - -perf-c10 - -With `https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip`: - -perf-c10-asynctcpsock - -**SSE performance** - -In the example, there is an endpoint `/events` with some comments showing how these metrics are calculated. - -Test is running for 20 seconds with 10 connections. - -``` -// With AsyncTCP, with 10 workers: no message discarded from the queue -// -// Total: 2038 events, 509.50 events / second -// Total: 2120 events, 530.00 events / second -// Total: 2119 events, 529.75 events / second -// Total: 2038 events, 509.50 events / second -// Total: 2037 events, 509.25 events / second -// Total: 2119 events, 529.75 events / second -// Total: 2119 events, 529.75 events / second -// Total: 2120 events, 530.00 events / second -// Total: 2038 events, 509.50 events / second -// Total: 2038 events, 509.50 events / second -// -// With AsyncTCPSock, with 10 workers: no message discarded from the queue -// -// Total: 2038 events, 509.50 events / second -// Total: 2120 events, 530.00 events / second -// Total: 2119 events, 529.75 events / second -// Total: 2038 events, 509.50 events / second -// Total: 2037 events, 509.25 events / second -// Total: 2119 events, 529.75 events / second -// Total: 2119 events, 529.75 events / second -// Total: 2120 events, 530.00 events / second -// Total: 2038 events, 509.50 events / second -// Total: 2038 events, 509.50 events / second +```ini +lib_compat_mode = strict +lib_ldf_mode = chain +platform = https://github.com/maxgerhardt/platform-raspberrypi.git +board = rpipicow +board_build.core = earlephilhower +lib_deps = + ayushsharma82/RPAsyncTCP@^1.3.1 + ESP32Async/ESPAsyncWebServer +lib_ignore = + lwIP_ESPHost +build_flags = ${env.build_flags} + -Wno-missing-field-initializers ``` ## Important recommendations for build options @@ -187,16 +117,16 @@ Here are some recommendations to avoid them and build-time flags you can change. In some bad network conditions you might consider increasing it. `CONFIG_ASYNC_TCP_QUEUE_SIZE` - defines the length of the queue for events related to connections handling. -Both the server and AsyncTCP library in this fork were optimized to control the queue automatically. Do NOT try blindly increasing the queue size, it does not help you in a way you might think it is. If you receive debug messages about queue throttling, try to optimize your server callbaks code to execute as fast as possible. +Both the server and AsyncTCP library were optimized to control the queue automatically. Do NOT try blindly increasing the queue size, it does not help you in a way you might think it is. If you receive debug messages about queue throttling, try to optimize your server callbacks code to execute as fast as possible. Read #165 thread, it might give you some hints. `CONFIG_ASYNC_TCP_RUNNING_CORE` - CPU core thread affinity that runs the queue events handling and executes server callbacks. Default is ANY core, so it means that for dualcore SoCs both cores could handle server activities. If your server's code is too heavy and unoptimized or you see that sometimes server might affect other network activities, you might consider to bind it to the same core that runs Arduino code (1) to minimize affect on radio part. Otherwise you can leave the default to let RTOS decide where to run the thread based on priority -`CONFIG_ASYNC_TCP_STACK_SIZE` - stack size for the thread that runs sever events and callbacks. Default is 16k that is a way too much waste for well-defined short async code or simple static file handling. You might want to cosider reducing it to 4-8k to same RAM usage. If you do not know what this is or not sure about your callback code demands - leave it as default, should be enough even for very hungry callbacks in most cases. +`CONFIG_ASYNC_TCP_STACK_SIZE` - stack size for the thread that runs sever events and callbacks. Default is 16k that is a way too much waste for well-defined short async code or simple static file handling. You might want to cosider reducing it to 4-8k to same RAM usage. If you do not know what this is or not sure about your callback code demands - leave it as default, should be enough even for very hungry callbacks in most cases. > [!NOTE] -> This relates to ESP32 only, ESP8266 uses different ESPAsyncTCP lib that does not has this build options +> This relates to ESP32 only, ESP8266 uses different ESPAsyncTCP lib that does not has this build options I personally use the following configuration in my projects: @@ -208,1794 +138,4 @@ I personally use the following configuration in my projects: -D CONFIG_ASYNC_TCP_STACK_SIZE=4096 // reduce the stack size (default is 16K) ``` -## `AsyncWebSocketMessageBuffer` and `makeBuffer()` - -The fork from [yubox-node-org](https://github.com/yubox-node-org/ESPAsyncWebServer) introduces some breaking API changes compared to the original library, especially regarding the use of `std::shared_ptr>` for WebSocket. - -This fork is compatible with the original library from [me-no-dev](https://github.com/me-no-dev/ESPAsyncWebServer) regarding WebSocket, and wraps the optimizations done by `yubox-node-org` in the `AsyncWebSocketMessageBuffer` class. -So you have the choice of which API to use. - -Here are examples for serializing a Json document in a websocket message buffer: - -```cpp -void send(JsonDocument& doc) { - const size_t len = measureJson(doc); - - // original API from me-no-dev - AsyncWebSocketMessageBuffer* buffer = _ws->makeBuffer(len); - assert(buffer); // up to you to keep or remove this - serializeJson(doc, buffer->get(), len); - _ws->textAll(buffer); -} -``` - -```cpp -void send(JsonDocument& doc) { - const size_t len = measureJson(doc); - - // this fork (originally from yubox-node-org), uses another API with shared pointer - auto buffer = std::make_shared>(len); - assert(buffer); // up to you to keep or remove this - serializeJson(doc, buffer->data(), len); - _ws->textAll(std::move(buffer)); -} -``` - -I recommend to use the official API `AsyncWebSocketMessageBuffer` to retain further compatibility. - -## How to replace a response - -```c++ - // It is possible to replace a response. - // The previous one will be deleted. - // Response sending happens when the handler returns. - server.on("/replace", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/plain", "Hello, world"); - // oups! finally we want to send a different response - request->send(400, "text/plain", "validation error"); - }); -``` - -This will send error 400 instead of 200. - -## How to use Middleware - -Middleware is a way to intercept requests to perform some operations on them, like authentication, authorization, logging, etc and also act on the response headers. - -Middleware can either be attached to individual handlers, attached at the server level (thus applied to all handlers), or both. -They will be executed in the order they are attached, and they can stop the request processing by sending a response themselves. - -You can have a look at the [SimpleServer.ino](https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/examples/SimpleServer/SimpleServer.ino) example for some use cases. - -For example, such middleware would handle authentication and set some attributes on the request to make them available for the next middleware and for the handler which will process the request. - -```c++ -AsyncMiddlewareFunction complexAuth([](AsyncWebServerRequest* request, ArMiddlewareNext next) { - if (!request->authenticate("user", "password")) { - return request->requestAuthentication(); - } - - request->setAttribute("user", "Mathieu"); - request->setAttribute("role", "staff"); - - next(); // continue processing - - // you can act one the response object - request->getResponse()->addHeader("X-Rate-Limit", "200"); -}); -``` - -**Here are the list of available middlewares:** - -- `AsyncMiddlewareFunction`: can convert a lambda function (`ArMiddlewareCallback`) to a middleware -- `AsyncAuthenticationMiddleware`: to handle basic/digest authentication globally or per handler -- `AsyncAuthorizationMiddleware`: to handle authorization globally or per handler -- `AsyncCorsMiddleware`: to handle CORS preflight request globally or per handler -- `AsyncHeaderFilterMiddleware`: to filter out headers from the request -- `AsyncHeaderFreeMiddleware`: to only keep some headers from the request, and remove the others -- `LoggerMiddleware`: to log requests globally or per handler with the same pattern as curl. Will also record request processing time -- `AsyncRateLimitMiddleware`: to limit the number of requests on a windows of time globally or per handler - -## How to use authentication with AsyncAuthenticationMiddleware - -Do not use the `setUsername()` and `setPassword()` methods on the hanlders anymore. -They are deprecated. -These methods were causing a copy of the username and password for each handler, which is not efficient. - -Now, you can use the `AsyncAuthenticationMiddleware` to handle authentication globally or per handler. - -```c++ -AsyncAuthenticationMiddleware authMiddleware; - -// [...] - -authMiddleware.setAuthType(AsyncAuthType::AUTH_DIGEST); -authMiddleware.setRealm("My app name"); -authMiddleware.setUsername("admin"); -authMiddleware.setPassword("admin"); -authMiddleware.setAuthFailureMessage("Authentication failed"); -authMiddleware.generateHash(); // optimization to avoid generating the hash at each request - -// [...] - -server.addMiddleware(&authMiddleware); // globally add authentication to the server - -// [...] - -myHandler.addMiddleware(&authMiddleware); // add authentication to a specific handler -``` - -## Migration to Middleware to improve performance and memory usage - -- `AsyncEventSource.authorizeConnect(...)` => do not use this method anymore: add a common `AsyncAuthorizationMiddleware` to the handler or server, and make sure to add it AFTER the `AsyncAuthenticationMiddleware` if you use authentication. -- `AsyncWebHandler.setAuthentication(...)` => do not use this method anymore: add a common `AsyncAuthenticationMiddleware` to the handler or server -- `ArUploadHandlerFunction` and `ArBodyHandlerFunction` => these callbacks receiving body data and upload and not calling anymore the authentication code for performance reasons. - These callbacks can be called multiple times during request parsing, so this is up to the user to now call the `AsyncAuthenticationMiddleware.allowed(request)` if needed and ideally when the method is called for the first time. - These callbacks are also not triggering the whole middleware chain since they are not part of the request processing workflow (they are not the final handler). - -## Original Documentation - -- [Why should you care](#why-should-you-care) -- [Important things to remember](#important-things-to-remember) -- [Principles of operation](#principles-of-operation) - - [The Async Web server](#the-async-web-server) - - [Request Life Cycle](#request-life-cycle) - - [Rewrites and how do they work](#rewrites-and-how-do-they-work) - - [Handlers and how do they work](#handlers-and-how-do-they-work) - - [Responses and how do they work](#responses-and-how-do-they-work) - - [Template processing](#template-processing) -- [Libraries and projects that use AsyncWebServer](#libraries-and-projects-that-use-asyncwebserver) -- [Request Variables](#request-variables) - - [Common Variables](#common-variables) - - [Headers](#headers) - - [GET, POST and FILE parameters](#get-post-and-file-parameters) - - [FILE Upload handling](#file-upload-handling) - - [Body data handling](#body-data-handling) - - [JSON body handling with ArduinoJson](#json-body-handling-with-arduinojson) -- [Responses](#responses) - - [Redirect to another URL](#redirect-to-another-url) - - [Basic response with HTTP Code](#basic-response-with-http-code) - - [Basic response with HTTP Code and extra headers](#basic-response-with-http-code-and-extra-headers) - - [Basic response with string content](#basic-response-with-string-content) - - [Basic response with string content and extra headers](#basic-response-with-string-content-and-extra-headers) - - [Send large webpage from PROGMEM](#send-large-webpage-from-progmem) - - [Send large webpage from PROGMEM and extra headers](#send-large-webpage-from-progmem-and-extra-headers) - - [Send large webpage from PROGMEM containing templates](#send-large-webpage-from-progmem-containing-templates) - - [Send large webpage from PROGMEM containing templates and extra headers](#send-large-webpage-from-progmem-containing-templates-and-extra-headers) - - [Send binary content from PROGMEM](#send-binary-content-from-progmem) - - [Respond with content coming from a Stream](#respond-with-content-coming-from-a-stream) - - [Respond with content coming from a Stream and extra headers](#respond-with-content-coming-from-a-stream-and-extra-headers) - - [Respond with content coming from a Stream containing templates](#respond-with-content-coming-from-a-stream-containing-templates) - - [Respond with content coming from a Stream containing templates and extra headers](#respond-with-content-coming-from-a-stream-containing-templates-and-extra-headers) - - [Respond with content coming from a File](#respond-with-content-coming-from-a-file) - - [Respond with content coming from a File and extra headers](#respond-with-content-coming-from-a-file-and-extra-headers) - - [Respond with content coming from a File containing templates](#respond-with-content-coming-from-a-file-containing-templates) - - [Respond with content using a callback](#respond-with-content-using-a-callback) - - [Respond with content using a callback and extra headers](#respond-with-content-using-a-callback-and-extra-headers) - - [Respond with file content using a callback and extra headers](#respond-with-file-content-using-a-callback-and-extra-headers) - - [Respond with content using a callback containing templates](#respond-with-content-using-a-callback-containing-templates) - - [Respond with content using a callback containing templates and extra headers](#respond-with-content-using-a-callback-containing-templates-and-extra-headers) - - [Chunked Response](#chunked-response) - - [Chunked Response containing templates](#chunked-response-containing-templates) - - [Print to response](#print-to-response) - - [ArduinoJson Basic Response](#arduinojson-basic-response) - - [ArduinoJson Advanced Response](#arduinojson-advanced-response) -- [Serving static files](#serving-static-files) - - [Serving specific file by name](#serving-specific-file-by-name) - - [Serving files in directory](#serving-files-in-directory) - - [Serving static files with authentication](#serving-static-files-with-authentication) - - [Specifying Cache-Control header](#specifying-cache-control-header) - - [Specifying Date-Modified header](#specifying-date-modified-header) - - [Specifying Template Processor callback](#specifying-template-processor-callback) - - [Serving static files by custom handling](#serving-static-files-by-custom-handling) -- [Param Rewrite With Matching](#param-rewrite-with-matching) -- [Using filters](#using-filters) - - [Serve different site files in AP mode](#serve-different-site-files-in-ap-mode) - - [Rewrite to different index on AP](#rewrite-to-different-index-on-ap) - - [Serving different hosts](#serving-different-hosts) - - [Determine interface inside callbacks](#determine-interface-inside-callbacks) -- [Bad Responses](#bad-responses) - - [Respond with content using a callback without content length to HTTP/1.0 clients](#respond-with-content-using-a-callback-without-content-length-to-http10-clients) -- [Async WebSocket Plugin](#async-websocket-plugin) - - [Async WebSocket Event](#async-websocket-event) - - [Methods for sending data to a socket client](#methods-for-sending-data-to-a-socket-client) - - [Direct access to web socket message buffer](#direct-access-to-web-socket-message-buffer) - - [Limiting the number of web socket clients](#limiting-the-number-of-web-socket-clients) -- [Async Event Source Plugin](#async-event-source-plugin) - - [Setup Event Source on the server](#setup-event-source-on-the-server) - - [Setup Event Source in the browser](#setup-event-source-in-the-browser) -- [Scanning for available WiFi Networks](#scanning-for-available-wifi-networks) -- [Remove handlers and rewrites](#remove-handlers-and-rewrites) -- [Setting up the server](#setting-up-the-server) - - [Setup global and class functions as request handlers](#setup-global-and-class-functions-as-request-handlers) - - [Methods for controlling websocket connections](#methods-for-controlling-websocket-connections) - - [Adding Default Headers](#adding-default-headers) - - [Path variable](#path-variable) - -### Why should you care - -- Using asynchronous network means that you can handle more than one connection at the same time -- You are called once the request is ready and parsed -- When you send the response, you are immediately ready to handle other connections - while the server is taking care of sending the response in the background -- Speed is OMG -- Easy to use API, HTTP Basic and Digest MD5 Authentication (default), ChunkedResponse -- Easily extendible to handle any type of content -- Supports Continue 100 -- Async WebSocket plugin offering different locations without extra servers or ports -- Async EventSource (Server-Sent Events) plugin to send events to the browser -- URL Rewrite plugin for conditional and permanent url rewrites -- ServeStatic plugin that supports cache, Last-Modified, default index and more -- Simple template processing engine to handle templates - -### Important things to remember - -- This is fully asynchronous server and as such does not run on the loop thread. -- You can not use yield or delay or any function that uses them inside the callbacks -- The server is smart enough to know when to close the connection and free resources -- You can not send more than one response to a single request - -### Principles of operation - -#### The Async Web server - -- Listens for connections -- Wraps the new clients into `Request` -- Keeps track of clients and cleans memory -- Manages `Rewrites` and apply them on the request url -- Manages `Handlers` and attaches them to Requests - -#### Request Life Cycle - -- TCP connection is received by the server -- The connection is wrapped inside `Request` object -- When the request head is received (type, url, get params, http version and host), - the server goes through all `Rewrites` (in the order they were added) to rewrite the url and inject query parameters, - next, it goes through all attached `Handlers`(in the order they were added) trying to find one - that `canHandle` the given request. If none are found, the default(catch-all) handler is attached. -- The rest of the request is received, calling the `handleUpload` or `handleBody` methods of the `Handler` if they are needed (POST+File/Body) -- When the whole request is parsed, the result is given to the `handleRequest` method of the `Handler` and is ready to be responded to -- In the `handleRequest` method, to the `Request` is attached a `Response` object (see below) that will serve the response data back to the client -- When the `Response` is sent, the client is closed and freed from the memory - -#### Rewrites and how do they work - -- The `Rewrites` are used to rewrite the request url and/or inject get parameters for a specific request url path. -- All `Rewrites` are evaluated on the request in the order they have been added to the server. -- The `Rewrite` will change the request url only if the request url (excluding get parameters) is fully match - the rewrite url, and when the optional `Filter` callback return true. -- Setting a `Filter` to the `Rewrite` enables to control when to apply the rewrite, decision can be based on - request url, http version, request host/port/target host, get parameters or the request client's localIP or remoteIP. -- Two filter callbacks are provided: `ON_AP_FILTER` to execute the rewrite when request is made to the AP interface, - `ON_STA_FILTER` to execute the rewrite when request is made to the STA interface. -- The `Rewrite` can specify a target url with optional get parameters, e.g. `/to-url?with=params` - -#### Handlers and how do they work - -- The `Handlers` are used for executing specific actions to particular requests -- One `Handler` instance can be attached to any request and lives together with the server -- Setting a `Filter` to the `Handler` enables to control when to apply the handler, decision can be based on - request url, http version, request host/port/target host, get parameters or the request client's localIP or remoteIP. -- Two filter callbacks are provided: `ON_AP_FILTER` to execute the rewrite when request is made to the AP interface, - `ON_STA_FILTER` to execute the rewrite when request is made to the STA interface. -- The `canHandle` method is used for handler specific control on whether the requests can be handled - and for declaring any interesting headers that the `Request` should parse. Decision can be based on request - method, request url, http version, request host/port/target host and get parameters -- Once a `Handler` is attached to given `Request` (`canHandle` returned true) - that `Handler` takes care to receive any file/data upload and attach a `Response` - once the `Request` has been fully parsed -- `Handlers` are evaluated in the order they are attached to the server. The `canHandle` is called only - if the `Filter` that was set to the `Handler` return true. -- The first `Handler` that can handle the request is selected, not further `Filter` and `canHandle` are called. - -#### Responses and how do they work - -- The `Response` objects are used to send the response data back to the client -- The `Response` object lives with the `Request` and is freed on end or disconnect -- Different techniques are used depending on the response type to send the data in packets - returning back almost immediately and sending the next packet when this one is received. - Any time in between is spent to run the user loop and handle other network packets -- Responding asynchronously is probably the most difficult thing for most to understand -- Many different options exist for the user to make responding a background task - -#### Template processing - -- ESPAsyncWebserver contains simple template processing engine. -- Template processing can be added to most response types. -- Currently it supports only replacing template placeholders with actual values. No conditional processing, cycles, etc. -- Placeholders are delimited with `%` symbols. Like this: `%TEMPLATE_PLACEHOLDER%`. -- It works by extracting placeholder name from response text and passing it to user provided function which should return actual value to be used instead of placeholder. -- Since it's user provided function, it is possible for library users to implement conditional processing and cycles themselves. -- Since it's impossible to know the actual response size after template processing step in advance (and, therefore, to include it in response headers), the response becomes [chunked](#chunked-response). - -### Libraries and projects that use AsyncWebServer - -- [WebSocketToSerial](https://github.com/hallard/WebSocketToSerial) - Debug serial devices through the web browser -- [Sattrack](https://github.com/Hopperpop/Sattrack) - Track the ISS with ESP8266 -- [ESP Radio](https://github.com/Edzelf/Esp-radio) - Icecast radio based on ESP8266 and VS1053 -- [VZero](https://github.com/andig/vzero) - the Wireless zero-config controller for volkszaehler.org -- [ESPurna](https://bitbucket.org/xoseperez/espurna) - ESPurna ("spark" in Catalan) is a custom C firmware for ESP8266 based smart switches. It was originally developed with the ITead Sonoff in mind. -- [fauxmoESP](https://bitbucket.org/xoseperez/fauxmoesp) - Belkin WeMo emulator library for ESP8266. -- [ESP-RFID](https://github.com/omersiar/esp-rfid) - MFRC522 RFID Access Control Management project for ESP8266. - -### Request Variables - -#### Common Variables - -```cpp -request->version(); // uint8_t: 0 = HTTP/1.0, 1 = HTTP/1.1 -request->method(); // enum: HTTP_GET, HTTP_POST, HTTP_DELETE, HTTP_PUT, HTTP_PATCH, HTTP_HEAD, HTTP_OPTIONS -request->url(); // String: URL of the request (not including host, port or GET parameters) -request->host(); // String: The requested host (can be used for virtual hosting) -request->contentType(); // String: ContentType of the request (not avaiable in Handler::canHandle) -request->contentLength(); // size_t: ContentLength of the request (not avaiable in Handler::canHandle) -request->multipart(); // bool: True if the request has content type "multipart" -``` - -#### Headers - -```cpp -//List all collected headers -int headers = request->headers(); -int i; -for(i=0;igetHeader(i); - Serial.printf("HEADER[%s]: %s\n", h->name().c_str(), h->value().c_str()); -} - -//get specific header by name -if(request->hasHeader("MyHeader")){ - AsyncWebHeader* h = request->getHeader("MyHeader"); - Serial.printf("MyHeader: %s\n", h->value().c_str()); -} - -//List all collected headers (Compatibility) -int headers = request->headers(); -int i; -for(i=0;iheaderName(i).c_str(), request->header(i).c_str()); -} - -//get specific header by name (Compatibility) -if(request->hasHeader("MyHeader")){ - Serial.printf("MyHeader: %s\n", request->header("MyHeader").c_str()); -} -``` - -#### GET, POST and FILE parameters - -```cpp -//List all parameters -int params = request->params(); -for(int i=0;igetParam(i); - if(p->isFile()){ //p->isPost() is also true - Serial.printf("FILE[%s]: %s, size: %u\n", p->name().c_str(), p->value().c_str(), p->size()); - } else if(p->isPost()){ - Serial.printf("POST[%s]: %s\n", p->name().c_str(), p->value().c_str()); - } else { - Serial.printf("GET[%s]: %s\n", p->name().c_str(), p->value().c_str()); - } -} - -//Check if GET parameter exists -if(request->hasParam("download")) - AsyncWebParameter* p = request->getParam("download"); - -//Check if POST (but not File) parameter exists -if(request->hasParam("download", true)) - AsyncWebParameter* p = request->getParam("download", true); - -//Check if FILE was uploaded -if(request->hasParam("download", true, true)) - AsyncWebParameter* p = request->getParam("download", true, true); - -//List all parameters (Compatibility) -int args = request->args(); -for(int i=0;iargName(i).c_str(), request->arg(i).c_str()); -} - -//Check if parameter exists (Compatibility) -if(request->hasArg("download")) - String arg = request->arg("download"); -``` - -#### FILE Upload handling - -```cpp -void handleUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final){ - if(!index){ - Serial.printf("UploadStart: %s\n", filename.c_str()); - } - for(size_t i=0; i(); - // ... -}); -server.addHandler(handler); -``` - -### Responses - -#### Redirect to another URL - -```cpp -//to local url -request->redirect("/login"); - -//to external url -request->redirect("http://esp8266.com"); -``` - -#### Basic response with HTTP Code - -```cpp -request->send(404); //Sends 404 File Not Found -``` - -#### Basic response with HTTP Code and extra headers - -```cpp -AsyncWebServerResponse *response = request->beginResponse(404); //Sends 404 File Not Found -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Basic response with string content - -```cpp -request->send(200, "text/plain", "Hello World!"); -``` - -#### Basic response with string content and extra headers - -```cpp -AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", "Hello World!"); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Send large webpage from PROGMEM - -```cpp -const char index_html[] PROGMEM = "..."; // large char array, tested with 14k -request->send_P(200, "text/html", index_html); -``` - -#### Send large webpage from PROGMEM and extra headers - -```cpp -const char index_html[] PROGMEM = "..."; // large char array, tested with 14k -AsyncWebServerResponse *response = request->beginResponse_P(200, "text/html", index_html); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Send large webpage from PROGMEM containing templates - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -const char index_html[] PROGMEM = "..."; // large char array, tested with 14k -request->send_P(200, "text/html", index_html, processor); -``` - -#### Send large webpage from PROGMEM containing templates and extra headers - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -const char index_html[] PROGMEM = "..."; // large char array, tested with 14k -AsyncWebServerResponse *response = request->beginResponse_P(200, "text/html", index_html, processor); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Send binary content from PROGMEM - -```cpp - -//File: favicon.ico.gz, Size: 726 -#define favicon_ico_gz_len 726 -const uint8_t favicon_ico_gz[] PROGMEM = { - 0x1F, 0x8B, 0x08, 0x08, 0x0B, 0x87, 0x90, 0x57, 0x00, 0x03, 0x66, 0x61, 0x76, 0x69, 0x63, 0x6F, - 0x6E, 0x2E, 0x69, 0x63, 0x6F, 0x00, 0xCD, 0x53, 0x5F, 0x48, 0x9A, 0x51, 0x14, 0xBF, 0x62, 0x6D, - 0x86, 0x96, 0xA9, 0x64, 0xD3, 0xFE, 0xA8, 0x99, 0x65, 0x1A, 0xB4, 0x8A, 0xA8, 0x51, 0x54, 0x23, - 0xA8, 0x11, 0x49, 0x51, 0x8A, 0x34, 0x62, 0x93, 0x85, 0x31, 0x58, 0x44, 0x12, 0x45, 0x2D, 0x58, - 0xF5, 0x52, 0x41, 0x10, 0x23, 0x82, 0xA0, 0x20, 0x98, 0x2F, 0xC1, 0x26, 0xED, 0xA1, 0x20, 0x89, - 0x04, 0xD7, 0x83, 0x58, 0x20, 0x28, 0x04, 0xAB, 0xD1, 0x9B, 0x8C, 0xE5, 0xC3, 0x60, 0x32, 0x64, - 0x0E, 0x56, 0xBF, 0x9D, 0xEF, 0xF6, 0x30, 0x82, 0xED, 0xAD, 0x87, 0xDD, 0x8F, 0xF3, 0xDD, 0x8F, - 0x73, 0xCF, 0xEF, 0x9C, 0xDF, 0x39, 0xBF, 0xFB, 0x31, 0x26, 0xA2, 0x27, 0x37, 0x97, 0xD1, 0x5B, - 0xCF, 0x9E, 0x67, 0x30, 0xA6, 0x66, 0x8C, 0x99, 0xC9, 0xC8, 0x45, 0x9E, 0x6B, 0x3F, 0x5F, 0x74, - 0xA6, 0x94, 0x5E, 0xDB, 0xFF, 0xB2, 0xE6, 0xE7, 0xE7, 0xF9, 0xDE, 0xD6, 0xD6, 0x96, 0xDB, 0xD8, - 0xD8, 0x78, 0xBF, 0xA1, 0xA1, 0xC1, 0xDA, 0xDC, 0xDC, 0x2C, 0xEB, 0xED, 0xED, 0x15, 0x9B, 0xCD, - 0xE6, 0x4A, 0x83, 0xC1, 0xE0, 0x2E, 0x29, 0x29, 0x99, 0xD6, 0x6A, 0xB5, 0x4F, 0x75, 0x3A, 0x9D, - 0x61, 0x75, 0x75, 0x95, 0xB5, 0xB7, 0xB7, 0xDF, 0xC8, 0xD1, 0xD4, 0xD4, 0xF4, 0xB0, 0xBA, 0xBA, - 0xFA, 0x83, 0xD5, 0x6A, 0xFD, 0x5A, 0x5E, 0x5E, 0x9E, 0x28, 0x2D, 0x2D, 0x0D, 0x10, 0xC6, 0x4B, - 0x98, 0x78, 0x5E, 0x5E, 0xDE, 0x95, 0x42, 0xA1, 0x40, 0x4E, 0x4E, 0xCE, 0x65, 0x76, 0x76, 0xF6, - 0x47, 0xB5, 0x5A, 0x6D, 0x4F, 0x26, 0x93, 0xA2, 0xD6, 0xD6, 0x56, 0x8E, 0x6D, 0x69, 0x69, 0xD1, - 0x11, 0x36, 0x62, 0xB1, 0x58, 0x60, 0x32, 0x99, 0xA0, 0xD7, 0xEB, 0x51, 0x58, 0x58, 0x88, 0xFC, - 0xFC, 0x7C, 0x10, 0x16, 0x02, 0x56, 0x2E, 0x97, 0x43, 0x2A, 0x95, 0x42, 0x2C, 0x16, 0x23, 0x33, - 0x33, 0x33, 0xAE, 0x52, 0xA9, 0x1E, 0x64, 0x65, 0x65, 0x71, 0x7C, 0x7D, 0x7D, 0xBD, 0x93, 0xEA, - 0xFE, 0x30, 0x1A, 0x8D, 0xE8, 0xEC, 0xEC, 0xC4, 0xE2, 0xE2, 0x22, 0x6A, 0x6A, 0x6A, 0x40, 0x39, - 0x41, 0xB5, 0x38, 0x4E, 0xC8, 0x33, 0x3C, 0x3C, 0x0C, 0x87, 0xC3, 0xC1, 0x6B, 0x54, 0x54, 0x54, - 0xBC, 0xE9, 0xEB, 0xEB, 0x93, 0x5F, 0x5C, 0x5C, 0x30, 0x8A, 0x9D, 0x2E, 0x2B, 0x2B, 0xBB, 0xA2, - 0x3E, 0x41, 0xBD, 0x21, 0x1E, 0x8F, 0x63, 0x6A, 0x6A, 0x0A, 0x81, 0x40, 0x00, 0x94, 0x1B, 0x3D, - 0x3D, 0x3D, 0x42, 0x3C, 0x96, 0x96, 0x96, 0x70, 0x7E, 0x7E, 0x8E, 0xE3, 0xE3, 0x63, 0xF8, 0xFD, - 0xFE, 0xB4, 0xD7, 0xEB, 0xF5, 0x8F, 0x8F, 0x8F, 0x5B, 0x68, 0x5E, 0x6F, 0x05, 0xCE, 0xB4, 0xE3, - 0xE8, 0xE8, 0x08, 0x27, 0x27, 0x27, 0xD8, 0xDF, 0xDF, 0xC7, 0xD9, 0xD9, 0x19, 0x6C, 0x36, 0x1B, - 0x36, 0x36, 0x36, 0x38, 0x9F, 0x85, 0x85, 0x05, 0xAC, 0xAF, 0xAF, 0x23, 0x1A, 0x8D, 0x22, 0x91, - 0x48, 0x20, 0x16, 0x8B, 0xFD, 0xDA, 0xDA, 0xDA, 0x7A, 0x41, 0x33, 0x7E, 0x57, 0x50, 0x50, 0x80, - 0x89, 0x89, 0x09, 0x84, 0xC3, 0x61, 0x6C, 0x6F, 0x6F, 0x23, 0x12, 0x89, 0xE0, 0xE0, 0xE0, 0x00, - 0x43, 0x43, 0x43, 0x58, 0x5E, 0x5E, 0xE6, 0x9C, 0x7D, 0x3E, 0x1F, 0x46, 0x47, 0x47, 0x79, 0xBE, - 0xBD, 0xBD, 0x3D, 0xE1, 0x3C, 0x1D, 0x0C, 0x06, 0x9F, 0x10, 0xB7, 0xC7, 0x84, 0x4F, 0xF6, 0xF7, - 0xF7, 0x63, 0x60, 0x60, 0x00, 0x83, 0x83, 0x83, 0x18, 0x19, 0x19, 0xC1, 0xDC, 0xDC, 0x1C, 0x8F, - 0x17, 0x7C, 0xA4, 0x27, 0xE7, 0x34, 0x39, 0x39, 0x89, 0x9D, 0x9D, 0x1D, 0x6E, 0x54, 0xE3, 0x13, - 0xE5, 0x34, 0x11, 0x37, 0x49, 0x51, 0x51, 0xD1, 0x4B, 0xA5, 0x52, 0xF9, 0x45, 0x26, 0x93, 0x5D, - 0x0A, 0xF3, 0x92, 0x48, 0x24, 0xA0, 0x6F, 0x14, 0x17, 0x17, 0xA3, 0xB6, 0xB6, 0x16, 0x5D, 0x5D, - 0x5D, 0x7C, 0x1E, 0xBB, 0xBB, 0xBB, 0x9C, 0xD7, 0xE1, 0xE1, 0x21, 0x42, 0xA1, 0xD0, 0x6B, 0xD2, - 0x45, 0x4C, 0x33, 0x12, 0x34, 0xCC, 0xA0, 0x19, 0x54, 0x92, 0x56, 0x0E, 0xD2, 0xD9, 0x43, 0xF8, - 0xCF, 0x82, 0x56, 0xC2, 0xDC, 0xEB, 0xEA, 0xEA, 0x38, 0x7E, 0x6C, 0x6C, 0x4C, 0xE0, 0xFE, 0x9D, - 0xB8, 0xBF, 0xA7, 0xFA, 0xAF, 0x56, 0x56, 0x56, 0xEE, 0x6D, 0x6E, 0x6E, 0xDE, 0xB8, 0x47, 0x55, - 0x55, 0x55, 0x6C, 0x66, 0x66, 0x46, 0x44, 0xDA, 0x3B, 0x34, 0x1A, 0x4D, 0x94, 0xB0, 0x3F, 0x09, - 0x7B, 0x45, 0xBD, 0xA5, 0x5D, 0x2E, 0x57, 0x8C, 0x7A, 0x73, 0xD9, 0xED, 0xF6, 0x3B, 0x84, 0xFF, - 0xE7, 0x7D, 0xA6, 0x3A, 0x2C, 0x95, 0x4A, 0xB1, 0x8E, 0x8E, 0x0E, 0x6D, 0x77, 0x77, 0xB7, 0xCD, - 0xE9, 0x74, 0x3E, 0x73, 0xBB, 0xDD, 0x8F, 0x3C, 0x1E, 0x8F, 0xE6, 0xF4, 0xF4, 0x94, 0xAD, 0xAD, - 0xAD, 0xDD, 0xDE, 0xCF, 0x73, 0x0B, 0x0B, 0xB8, 0xB6, 0xE0, 0x5D, 0xC6, 0x66, 0xC5, 0xE4, 0x10, - 0x4C, 0xF4, 0xF7, 0xD8, 0x59, 0xF2, 0x7F, 0xA3, 0xB8, 0xB4, 0xFC, 0x0F, 0xEE, 0x37, 0x70, 0xEC, - 0x16, 0x4A, 0x7E, 0x04, 0x00, 0x00 -}; - -AsyncWebServerResponse *response = request->beginResponse_P(200, "image/x-icon", favicon_ico_gz, favicon_ico_gz_len); -response->addHeader("Content-Encoding", "gzip"); -request->send(response); -``` - -#### Respond with content coming from a Stream - -```cpp -//read 12 bytes from Serial and send them as Content Type text/plain -request->send(Serial, "text/plain", 12); -``` - -#### Respond with content coming from a Stream and extra headers - -```cpp -//read 12 bytes from Serial and send them as Content Type text/plain -AsyncWebServerResponse *response = request->beginResponse(Serial, "text/plain", 12); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Respond with content coming from a Stream containing templates - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -//read 12 bytes from Serial and send them as Content Type text/plain -request->send(Serial, "text/plain", 12, processor); -``` - -#### Respond with content coming from a Stream containing templates and extra headers - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -//read 12 bytes from Serial and send them as Content Type text/plain -AsyncWebServerResponse *response = request->beginResponse(Serial, "text/plain", 12, processor); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Respond with content coming from a File - -```cpp -//Send index.htm with default content type -request->send(SPIFFS, "/index.htm"); - -//Send index.htm as text -request->send(SPIFFS, "/index.htm", "text/plain"); - -//Download index.htm -request->send(SPIFFS, "/index.htm", String(), true); -``` - -#### Respond with content coming from a File and extra headers - -```cpp -//Send index.htm with default content type -AsyncWebServerResponse *response = request->beginResponse(SPIFFS, "/index.htm"); - -//Send index.htm as text -AsyncWebServerResponse *response = request->beginResponse(SPIFFS, "/index.htm", "text/plain"); - -//Download index.htm -AsyncWebServerResponse *response = request->beginResponse(SPIFFS, "/index.htm", String(), true); - -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Respond with content coming from a File containing templates - -Internally uses [Chunked Response](#chunked-response). - -Index.htm contents: - -``` -%HELLO_FROM_TEMPLATE% -``` - -Somewhere in source files: - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -//Send index.htm with template processor function -request->send(SPIFFS, "/index.htm", String(), false, processor); -``` - -#### Respond with content using a callback - -```cpp -//send 128 bytes as plain text -request->send("text/plain", 128, [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { - //Write up to "maxLen" bytes into "buffer" and return the amount written. - //index equals the amount of bytes that have been already sent - //You will not be asked for more bytes once the content length has been reached. - //Keep in mind that you can not delay or yield waiting for more data! - //Send what you currently have and you will be asked for more again - return mySource.read(buffer, maxLen); -}); -``` - -#### Respond with content using a callback and extra headers - -```cpp -//send 128 bytes as plain text -AsyncWebServerResponse *response = request->beginResponse("text/plain", 128, [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { - //Write up to "maxLen" bytes into "buffer" and return the amount written. - //index equals the amount of bytes that have been already sent - //You will not be asked for more bytes once the content length has been reached. - //Keep in mind that you can not delay or yield waiting for more data! - //Send what you currently have and you will be asked for more again - return mySource.read(buffer, maxLen); -}); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Respond with file content using a callback and extra headers - -With this code your ESP is able to serve even large (large in terms of ESP, e.g. 100kB) files -without memory problems. - -You need to create a file handler in outer function (to have a single one for request) but use -it in a lambda. The catch is that the lambda has it's own lifecycle which may/will cause it's -called after the original function is over thus the original file handle is destroyed. Using the -captured `&file` in the lambda then causes segfault (Hello, Exception 9!) and the whole ESP crashes. -By using this code, you tell the compiler to move the handle into the lambda so it won't be -destroyed when outer function (that one where you call `request->send(response)`) ends. - -```cpp -const File file = ... // e.g. SPIFFS.open(path, "r"); - -const contentType = "application/javascript"; - -AsyncWebServerResponse *response = request->beginResponse( - contentType, - file.size(), - [file](uint8_t *buffer, size_t maxLen, size_t total) mutable -> size_t { - int bytes = file.read(buffer, maxLen); - - // close file at the end - if (bytes + total == file.size()) file.close(); - - return max(0, bytes); // return 0 even when no bytes were loaded - } -); - -if (gzipped) { - response->addHeader(F("Content-Encoding"), F("gzip")); -} - -request->send(response); -``` - -#### Respond with content using a callback containing templates - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -//send 128 bytes as plain text -request->send("text/plain", 128, [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { - //Write up to "maxLen" bytes into "buffer" and return the amount written. - //index equals the amount of bytes that have been already sent - //You will not be asked for more bytes once the content length has been reached. - //Keep in mind that you can not delay or yield waiting for more data! - //Send what you currently have and you will be asked for more again - return mySource.read(buffer, maxLen); -}, processor); -``` - -#### Respond with content using a callback containing templates and extra headers - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -//send 128 bytes as plain text -AsyncWebServerResponse *response = request->beginResponse("text/plain", 128, [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { - //Write up to "maxLen" bytes into "buffer" and return the amount written. - //index equals the amount of bytes that have been already sent - //You will not be asked for more bytes once the content length has been reached. - //Keep in mind that you can not delay or yield waiting for more data! - //Send what you currently have and you will be asked for more again - return mySource.read(buffer, maxLen); -}, processor); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Chunked Response - -Used when content length is unknown. Works best if the client supports HTTP/1.1 - -```cpp -AsyncWebServerResponse *response = request->beginChunkedResponse("text/plain", [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { - //Write up to "maxLen" bytes into "buffer" and return the amount written. - //index equals the amount of bytes that have been already sent - //You will be asked for more data until 0 is returned - //Keep in mind that you can not delay or yield waiting for more data! - return mySource.read(buffer, maxLen); -}); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Chunked Response containing templates - -Used when content length is unknown. Works best if the client supports HTTP/1.1 - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -AsyncWebServerResponse *response = request->beginChunkedResponse("text/plain", [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { - //Write up to "maxLen" bytes into "buffer" and return the amount written. - //index equals the amount of bytes that have been already sent - //You will be asked for more data until 0 is returned - //Keep in mind that you can not delay or yield waiting for more data! - return mySource.read(buffer, maxLen); -}, processor); -response->addHeader("Server","ESP Async Web Server"); -request->send(response); -``` - -#### Print to response - -```cpp -AsyncResponseStream *response = request->beginResponseStream("text/html"); -response->addHeader("Server","ESP Async Web Server"); -response->printf("Webpage at %s", request->url().c_str()); - -response->print("

Hello "); -response->print(request->client()->remoteIP()); -response->print("

"); - -response->print("

General

"); -response->print("
    "); -response->printf("
  • Version: HTTP/1.%u
    • ", request->version()); -response->printf("
  • Method: %s
    • ", request->methodToString()); -response->printf("
  • URL: %s
    • ", request->url().c_str()); -response->printf("
  • Host: %s
    • ", request->host().c_str()); -response->printf("
  • ContentType: %s
    • ", request->contentType().c_str()); -response->printf("
  • ContentLength: %u
    • ", request->contentLength()); -response->printf("
  • Multipart: %s
    • ", request->multipart()?"true":"false"); -response->print("
"); - -response->print("

Headers

"); -response->print("
    "); -int headers = request->headers(); -for(int i=0;igetHeader(i); - response->printf("
  • %s: %s
    • ", h->name().c_str(), h->value().c_str()); -} -response->print("
"); - -response->print("

Parameters

"); -response->print("
    "); -int params = request->params(); -for(int i=0;igetParam(i); - if(p->isFile()){ - response->printf("
  • FILE[%s]: %s, size: %u
    • ", p->name().c_str(), p->value().c_str(), p->size()); - } else if(p->isPost()){ - response->printf("
  • POST[%s]: %s
    • ", p->name().c_str(), p->value().c_str()); - } else { - response->printf("
  • GET[%s]: %s
    • ", p->name().c_str(), p->value().c_str()); - } -} -response->print("
"); - -response->print(""); -//send the response last -request->send(response); -``` - -#### ArduinoJson Basic Response - -This way of sending Json is great for when the result is below 4KB - -```cpp -#include "AsyncJson.h" -#include "ArduinoJson.h" - - -AsyncResponseStream *response = request->beginResponseStream("application/json"); -DynamicJsonBuffer jsonBuffer; -JsonObject &root = jsonBuffer.createObject(); -root["heap"] = ESP.getFreeHeap(); -root["ssid"] = WiFi.SSID(); -root.printTo(*response); -request->send(response); -``` - -#### ArduinoJson Advanced Response - -This response can handle really large Json objects (tested to 40KB) -There isn't any noticeable speed decrease for small results with the method above -Since ArduinoJson does not allow reading parts of the string, the whole Json has to -be passed every time a chunks needs to be sent, which shows speed decrease proportional -to the resulting json packets - -```cpp -#include "AsyncJson.h" -#include "ArduinoJson.h" - - -AsyncJsonResponse * response = new AsyncJsonResponse(); -response->addHeader("Server","ESP Async Web Server"); -JsonObject& root = response->getRoot(); -root["heap"] = ESP.getFreeHeap(); -root["ssid"] = WiFi.SSID(); -response->setLength(); -request->send(response); -``` - -### Serving static files - -In addition to serving files from SPIFFS as described above, the server provide a dedicated handler that optimize the -performance of serving files from SPIFFS - `AsyncStaticWebHandler`. Use `server.serveStatic()` function to -initialize and add a new instance of `AsyncStaticWebHandler` to the server. -The Handler will not handle the request if the file does not exists, e.g. the server will continue to look for another -handler that can handle the request. -Notice that you can chain setter functions to setup the handler, or keep a pointer to change it at a later time. - -#### Serving specific file by name - -```cpp -// Serve the file "/www/page.htm" when request url is "/page.htm" -server.serveStatic("/page.htm", SPIFFS, "/www/page.htm"); -``` - -#### Serving files in directory - -To serve files in a directory, the path to the files should specify a directory in SPIFFS and ends with "/". - -```cpp -// Serve files in directory "/www/" when request url starts with "/" -// Request to the root or none existing files will try to server the defualt -// file name "index.htm" if exists -server.serveStatic("/", SPIFFS, "/www/"); - -// Server with different default file -server.serveStatic("/", SPIFFS, "/www/").setDefaultFile("default.html"); -``` - -#### Serving static files with authentication - -```cpp -server - .serveStatic("/", SPIFFS, "/www/") - .setDefaultFile("default.html") - .setAuthentication("user", "pass"); -``` - -#### Specifying Cache-Control header - -It is possible to specify Cache-Control header value to reduce the number of calls to the server once the client loaded -the files. For more information on Cache-Control values see [Cache-Control](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) - -```cpp -// Cache responses for 10 minutes (600 seconds) -server.serveStatic("/", SPIFFS, "/www/").setCacheControl("max-age=600"); - -//*** Change Cache-Control after server setup *** - -// During setup - keep a pointer to the handler -AsyncStaticWebHandler* handler = &server.serveStatic("/", SPIFFS, "/www/").setCacheControl("max-age=600"); - -// At a later event - change Cache-Control -handler->setCacheControl("max-age=30"); -``` - -#### Specifying Date-Modified header - -It is possible to specify Date-Modified header to enable the server to return Not-Modified (304) response for requests -with "If-Modified-Since" header with the same value, instead of responding with the actual file content. - -```cpp -// Update the date modified string every time files are updated -server.serveStatic("/", SPIFFS, "/www/").setLastModified("Mon, 20 Jun 2016 14:00:00 GMT"); - -//*** Chage last modified value at a later stage *** - -// During setup - read last modified value from config or EEPROM -String date_modified = loadDateModified(); -AsyncStaticWebHandler* handler = &server.serveStatic("/", SPIFFS, "/www/"); -handler->setLastModified(date_modified); - -// At a later event when files are updated -String date_modified = getNewDateModfied(); -saveDateModified(date_modified); // Save for next reset -handler->setLastModified(date_modified); -``` - -#### Specifying Template Processor callback - -It is possible to specify template processor for static files. For information on template processor see -[Respond with content coming from a File containing templates](#respond-with-content-coming-from-a-file-containing-templates). - -```cpp -String processor(const String& var) -{ - if(var == "HELLO_FROM_TEMPLATE") - return F("Hello world!"); - return String(); -} - -// ... - -server.serveStatic("/", SPIFFS, "/www/").setTemplateProcessor(processor); -``` - -#### Serving static files by custom handling - -It may happen your static files are too big and the ESP will crash the request before it sends the whole file. -In that case, you can handle static files with custom file serving through not found handler. - -This code below is more-or-less equivalent to this: - -```cpp -webServer.serveStatic("/", SPIFFS, STATIC_FILES_PREFIX).setDefaultFile("index.html") -``` - -First, declare the handling function: - -```cpp -bool handleStaticFile(AsyncWebServerRequest *request) { - String path = STATIC_FILES_PREFIX + request->url(); - - if (path.endsWith("/")) path += F("index.html"); - - String contentType = getContentType(path); - String pathWithGz = path + ".gz"; - - if (SPIFFS.exists(pathWithGz) || SPIFFS.exists(path)) { - bool gzipped = false; - if (SPIFFS.exists(pathWithGz)) { - gzipped = true; - path += ".gz"; - } - - // TODO serve the file - - return true; - } - - return false; -} -``` - -And then configure your webserver: - -```cpp -webServer.onNotFound([](AsyncWebServerRequest *request) { - if (handleStaticFile(request)) return; - - request->send(404); -}); -``` - -You may want to try [Respond with file content using a callback and extra headers](#respond-with-file-content-using-a-callback-and-extra-headers) -For actual serving the file. - -### Param Rewrite With Matching - -It is possible to rewrite the request url with parameter match. Here is an example with one parameter: -Rewrite for example "/radio/{frequence}" -> "/radio?f={frequence}" - -```cpp -class OneParamRewrite : public AsyncWebRewrite -{ - protected: - String _urlPrefix; - int _paramIndex; - String _paramsBackup; - - public: - OneParamRewrite(const char* from, const char* to) - : AsyncWebRewrite(from, to) { - - _paramIndex = _from.indexOf('{'); - - if( _paramIndex >=0 && _from.endsWith("}")) { - _urlPrefix = _from.substring(0, _paramIndex); - int index = _params.indexOf('{'); - if(index >= 0) { - _params = _params.substring(0, index); - } - } else { - _urlPrefix = _from; - } - _paramsBackup = _params; - } - - bool match(AsyncWebServerRequest *request) override { - if(request->url().startsWith(_urlPrefix)) { - if(_paramIndex >= 0) { - _params = _paramsBackup + request->url().substring(_paramIndex); - } else { - _params = _paramsBackup; - } - return true; - - } else { - return false; - } - } -}; -``` - -Usage: - -```cpp - server.addRewrite( new OneParamRewrite("/radio/{frequence}", "/radio?f={frequence}") ); -``` - -### Using filters - -Filters can be set to `Rewrite` or `Handler` in order to control when to apply the rewrite and consider the handler. -A filter is a callback function that evaluates the request and return a boolean `true` to include the item -or `false` to exclude it. -Two filter callback are provided for convince: - -- `ON_STA_FILTER` - return true when requests are made to the STA (station mode) interface. -- `ON_AP_FILTER` - return true when requests are made to the AP (access point) interface. - -#### Serve different site files in AP mode - -```cpp -server.serveStatic("/", SPIFFS, "/www/").setFilter(ON_STA_FILTER); -server.serveStatic("/", SPIFFS, "/ap/").setFilter(ON_AP_FILTER); -``` - -#### Rewrite to different index on AP - -```cpp -// Serve the file "/www/index-ap.htm" in AP, and the file "/www/index.htm" on STA -server.rewrite("/", "index.htm"); -server.rewrite("/index.htm", "index-ap.htm").setFilter(ON_AP_FILTER); -server.serveStatic("/", SPIFFS, "/www/"); -``` - -#### Serving different hosts - -```cpp -// Filter callback using request host -bool filterOnHost1(AsyncWebServerRequest *request) { return request->host() == "host1"; } - -// Server setup: server files in "/host1/" to requests for "host1", and files in "/www/" otherwise. -server.serveStatic("/", SPIFFS, "/host1/").setFilter(filterOnHost1); -server.serveStatic("/", SPIFFS, "/www/"); -``` - -#### Determine interface inside callbacks - -```cpp - String RedirectUrl = "http://"; - if (ON_STA_FILTER(request)) { - RedirectUrl += WiFi.localIP().toString(); - } else { - RedirectUrl += WiFi.softAPIP().toString(); - } - RedirectUrl += "/index.htm"; - request->redirect(RedirectUrl); -``` - -### Bad Responses - -Some responses are implemented, but you should not use them, because they do not conform to HTTP. -The following example will lead to unclean close of the connection and more time wasted -than providing the length of the content - -#### Respond with content using a callback without content length to HTTP/1.0 clients - -```cpp -//This is used as fallback for chunked responses to HTTP/1.0 Clients -request->send("text/plain", 0, [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { - //Write up to "maxLen" bytes into "buffer" and return the amount written. - //You will be asked for more data until 0 is returned - //Keep in mind that you can not delay or yield waiting for more data! - return mySource.read(buffer, maxLen); -}); -``` - -### Async WebSocket Plugin - -The server includes a web socket plugin which lets you define different WebSocket locations to connect to -without starting another listening service or using different port - -#### Async WebSocket Event - -```cpp - -void onEvent(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len){ - if(type == WS_EVT_CONNECT){ - //client connected - os_printf("ws[%s][%u] connect\n", server->url(), client->id()); - client->printf("Hello Client %u :)", client->id()); - client->ping(); - } else if(type == WS_EVT_DISCONNECT){ - //client disconnected - os_printf("ws[%s][%u] disconnect: %u\n", server->url(), client->id()); - } else if(type == WS_EVT_ERROR){ - //error was received from the other end - os_printf("ws[%s][%u] error(%u): %s\n", server->url(), client->id(), *((uint16_t*)arg), (char*)data); - } else if(type == WS_EVT_PONG){ - //pong message was received (in response to a ping request maybe) - os_printf("ws[%s][%u] pong[%u]: %s\n", server->url(), client->id(), len, (len)?(char*)data:""); - } else if(type == WS_EVT_DATA){ - //data packet - AwsFrameInfo * info = (AwsFrameInfo*)arg; - if(info->final && info->index == 0 && info->len == len){ - //the whole message is in a single frame and we got all of it's data - os_printf("ws[%s][%u] %s-message[%llu]: ", server->url(), client->id(), (info->opcode == WS_TEXT)?"text":"binary", info->len); - if(info->opcode == WS_TEXT){ - data[len] = 0; - os_printf("%s\n", (char*)data); - } else { - for(size_t i=0; i < info->len; i++){ - os_printf("%02x ", data[i]); - } - os_printf("\n"); - } - if(info->opcode == WS_TEXT) - client->text("I got your text message"); - else - client->binary("I got your binary message"); - } else { - //message is comprised of multiple frames or the frame is split into multiple packets - if(info->index == 0){ - if(info->num == 0) - os_printf("ws[%s][%u] %s-message start\n", server->url(), client->id(), (info->message_opcode == WS_TEXT)?"text":"binary"); - os_printf("ws[%s][%u] frame[%u] start[%llu]\n", server->url(), client->id(), info->num, info->len); - } - - os_printf("ws[%s][%u] frame[%u] %s[%llu - %llu]: ", server->url(), client->id(), info->num, (info->message_opcode == WS_TEXT)?"text":"binary", info->index, info->index + len); - if(info->message_opcode == WS_TEXT){ - data[len] = 0; - os_printf("%s\n", (char*)data); - } else { - for(size_t i=0; i < len; i++){ - os_printf("%02x ", data[i]); - } - os_printf("\n"); - } - - if((info->index + len) == info->len){ - os_printf("ws[%s][%u] frame[%u] end[%llu]\n", server->url(), client->id(), info->num, info->len); - if(info->final){ - os_printf("ws[%s][%u] %s-message end\n", server->url(), client->id(), (info->message_opcode == WS_TEXT)?"text":"binary"); - if(info->message_opcode == WS_TEXT) - client->text("I got your text message"); - else - client->binary("I got your binary message"); - } - } - } - } -} -``` - -#### Methods for sending data to a socket client - -```cpp - - - -//Server methods -AsyncWebSocket ws("/ws"); -//printf to a client -ws.printf((uint32_t)client_id, arguments...); -//printf to all clients -ws.printfAll(arguments...); -//printf_P to a client -ws.printf_P((uint32_t)client_id, PSTR(format), arguments...); -//printfAll_P to all clients -ws.printfAll_P(PSTR(format), arguments...); -//send text to a client -ws.text((uint32_t)client_id, (char*)text); -ws.text((uint32_t)client_id, (uint8_t*)text, (size_t)len); -//send text from PROGMEM to a client -ws.text((uint32_t)client_id, PSTR("text")); -const char flash_text[] PROGMEM = "Text to send" -ws.text((uint32_t)client_id, FPSTR(flash_text)); -//send text to all clients -ws.textAll((char*)text); -ws.textAll((uint8_t*)text, (size_t)len); -//send binary to a client -ws.binary((uint32_t)client_id, (char*)binary); -ws.binary((uint32_t)client_id, (uint8_t*)binary, (size_t)len); -//send binary from PROGMEM to a client -const uint8_t flash_binary[] PROGMEM = { 0x01, 0x02, 0x03, 0x04 }; -ws.binary((uint32_t)client_id, flash_binary, 4); -//send binary to all clients -ws.binaryAll((char*)binary); -ws.binaryAll((uint8_t*)binary, (size_t)len); -//HTTP Authenticate before switch to Websocket protocol -ws.setAuthentication("user", "pass"); - -//client methods -AsyncWebSocketClient * client; -//printf -client->printf(arguments...); -//printf_P -client->printf_P(PSTR(format), arguments...); -//send text -client->text((char*)text); -client->text((uint8_t*)text, (size_t)len); -//send text from PROGMEM -client->text(PSTR("text")); -const char flash_text[] PROGMEM = "Text to send"; -client->text(FPSTR(flash_text)); -//send binary -client->binary((char*)binary); -client->binary((uint8_t*)binary, (size_t)len); -//send binary from PROGMEM -const uint8_t flash_binary[] PROGMEM = { 0x01, 0x02, 0x03, 0x04 }; -client->binary(flash_binary, 4); -``` - -#### Direct access to web socket message buffer - -When sending a web socket message using the above methods a buffer is created. Under certain circumstances you might want to manipulate or populate this buffer directly from your application, for example to prevent unnecessary duplications of the data. This example below shows how to create a buffer and print data to it from an ArduinoJson object then send it. - -```cpp -void sendDataWs(AsyncWebSocketClient * client) -{ - DynamicJsonBuffer jsonBuffer; - JsonObject& root = jsonBuffer.createObject(); - root["a"] = "abc"; - root["b"] = "abcd"; - root["c"] = "abcde"; - root["d"] = "abcdef"; - root["e"] = "abcdefg"; - size_t len = root.measureLength(); - AsyncWebSocketMessageBuffer * buffer = ws.makeBuffer(len); // creates a buffer (len + 1) for you. - if (buffer) { - root.printTo((char *)buffer->get(), len + 1); - if (client) { - client->text(buffer); - } else { - ws.textAll(buffer); - } - } -} -``` - -#### Limiting the number of web socket clients - -Browsers sometimes do not correctly close the websocket connection, even when the close() function is called in javascript. This will eventually exhaust the web server's resources and will cause the server to crash. Periodically calling the cleanClients() function from the main loop() function limits the number of clients by closing the oldest client when the maximum number of clients has been exceeded. This can called be every cycle, however, if you wish to use less power, then calling as infrequently as once per second is sufficient. - -```cpp -void loop(){ - ws.cleanupClients(); -} -``` - -### Async Event Source Plugin - -The server includes EventSource (Server-Sent Events) plugin which can be used to send short text events to the browser. -Difference between EventSource and WebSockets is that EventSource is single direction, text-only protocol. - -#### Setup Event Source on the server - -```cpp -AsyncWebServer server(80); -AsyncEventSource events("/events"); - -void setup(){ - // setup ...... - events.onConnect([](AsyncEventSourceClient *client){ - if(client->lastId()){ - Serial.printf("Client reconnected! Last message ID that it gat is: %u\n", client->lastId()); - } - //send event with message "hello!", id current millis - // and set reconnect delay to 1 second - client->send("hello!",NULL,millis(),1000); - }); - //HTTP Basic authentication - events.setAuthentication("user", "pass"); - server.addHandler(&events); - // setup ...... -} - -void loop(){ - if(eventTriggered){ // your logic here - //send event "myevent" - events.send("my event content","myevent",millis()); - } -} -``` - -#### Setup Event Source in the browser - -```javascript -if (!!window.EventSource) { - var source = new EventSource("/events"); - - source.addEventListener( - "open", - function (e) { - console.log("Events Connected"); - }, - false - ); - - source.addEventListener( - "error", - function (e) { - if (e.target.readyState != EventSource.OPEN) { - console.log("Events Disconnected"); - } - }, - false - ); - - source.addEventListener( - "message", - function (e) { - console.log("message", e.data); - }, - false - ); - - source.addEventListener( - "myevent", - function (e) { - console.log("myevent", e.data); - }, - false - ); -} -``` - -### Scanning for available WiFi Networks - -```cpp -//First request will return 0 results unless you start scan from somewhere else (loop/setup) -//Do not request more often than 3-5 seconds -server.on("/scan", HTTP_GET, [](AsyncWebServerRequest *request){ - String json = "["; - int n = WiFi.scanComplete(); - if(n == -2){ - WiFi.scanNetworks(true); - } else if(n){ - for (int i = 0; i < n; ++i){ - if(i) json += ","; - json += "{"; - json += "\"rssi\":"+String(WiFi.RSSI(i)); - json += ",\"ssid\":\""+WiFi.SSID(i)+"\""; - json += ",\"bssid\":\""+WiFi.BSSIDstr(i)+"\""; - json += ",\"channel\":"+String(WiFi.channel(i)); - json += ",\"secure\":"+String(WiFi.encryptionType(i)); - json += ",\"hidden\":"+String(WiFi.isHidden(i)?"true":"false"); - json += "}"; - } - WiFi.scanDelete(); - if(WiFi.scanComplete() == -2){ - WiFi.scanNetworks(true); - } - } - json += "]"; - request->send(200, "application/json", json); - json = String(); -}); -``` - -### Remove handlers and rewrites - -Server goes through handlers in same order as they were added. You can't simple add handler with same path to override them. -To remove handler: - -```arduino -// save callback for particular URL path -auto handler = server.on("/some/path", [](AsyncWebServerRequest *request){ - //do something useful -}); -// when you don't need handler anymore remove it -server.removeHandler(&handler); - -// same with rewrites -server.removeRewrite(&someRewrite); - -server.onNotFound([](AsyncWebServerRequest *request){ - request->send(404); -}); - -// remove server.onNotFound handler -server.onNotFound(NULL); - -// remove all rewrites, handlers and onNotFound/onFileUpload/onRequestBody callbacks -server.reset(); -``` - -### Setting up the server - -```cpp -#include "ESPAsyncTCP.h" -#include "ESPAsyncWebServer.h" - -AsyncWebServer server(80); -AsyncWebSocket ws("/ws"); // access at ws://[esp ip]/ws -AsyncEventSource events("/events"); // event source (Server-Sent events) - -const char* ssid = "your-ssid"; -const char* password = "your-pass"; -const char* http_username = "admin"; -const char* http_password = "admin"; - -//flag to use from web update to reboot the ESP -bool shouldReboot = false; - -void onRequest(AsyncWebServerRequest *request){ - //Handle Unknown Request - request->send(404); -} - -void onBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total){ - //Handle body -} - -void onUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final){ - //Handle upload -} - -void onEvent(AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, void * arg, uint8_t *data, size_t len){ - //Handle WebSocket event -} - -void setup(){ - Serial.begin(115200); - WiFi.mode(WIFI_STA); - WiFi.begin(ssid, password); - if (WiFi.waitForConnectResult() != WL_CONNECTED) { - Serial.printf("WiFi Failed!\n"); - return; - } - - // attach AsyncWebSocket - ws.onEvent(onEvent); - server.addHandler(&ws); - - // attach AsyncEventSource - server.addHandler(&events); - - // respond to GET requests on URL /heap - server.on("/heap", HTTP_GET, [](AsyncWebServerRequest *request){ - request->send(200, "text/plain", String(ESP.getFreeHeap())); - }); - - // upload a file to /upload - server.on("/upload", HTTP_POST, [](AsyncWebServerRequest *request){ - request->send(200); - }, onUpload); - - // send a file when /index is requested - server.on("/index", HTTP_ANY, [](AsyncWebServerRequest *request){ - request->send(SPIFFS, "/index.htm"); - }); - - // HTTP basic authentication - server.on("/login", HTTP_GET, [](AsyncWebServerRequest *request){ - if(!request->authenticate(http_username, http_password)) - return request->requestAuthentication(); - request->send(200, "text/plain", "Login Success!"); - }); - - // Simple Firmware Update Form - server.on("/update", HTTP_GET, [](AsyncWebServerRequest *request){ - request->send(200, "text/html", "
"); - }); - server.on("/update", HTTP_POST, [](AsyncWebServerRequest *request){ - shouldReboot = !Update.hasError(); - AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", shouldReboot?"OK":"FAIL"); - response->addHeader("Connection", "close"); - request->send(response); - },[](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final){ - if(!index){ - Serial.printf("Update Start: %s\n", filename.c_str()); - Update.runAsync(true); - if(!Update.begin((ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000)){ - Update.printError(Serial); - } - } - if(!Update.hasError()){ - if(Update.write(data, len) != len){ - Update.printError(Serial); - } - } - if(final){ - if(Update.end(true)){ - Serial.printf("Update Success: %uB\n", index+len); - } else { - Update.printError(Serial); - } - } - }); - - // attach filesystem root at URL /fs - server.serveStatic("/fs", SPIFFS, "/"); - - // Catch-All Handlers - // Any request that can not find a Handler that canHandle it - // ends in the callbacks below. - server.onNotFound(onRequest); - server.onFileUpload(onUpload); - server.onRequestBody(onBody); - - server.begin(); -} - -void loop(){ - if(shouldReboot){ - Serial.println("Rebooting..."); - delay(100); - ESP.restart(); - } - static char temp[128]; - sprintf(temp, "Seconds since boot: %u", millis()/1000); - events.send(temp, "time"); //send event "time" -} -``` - -#### Setup global and class functions as request handlers - -```cpp -#include -#include -#include -#include - -void handleRequest(AsyncWebServerRequest *request){} - -class WebClass { -public : - AsyncWebServer classWebServer = AsyncWebServer(81); - - WebClass(){}; - - void classRequest (AsyncWebServerRequest *request){} - - void begin(){ - // attach global request handler - classWebServer.on("/example", HTTP_ANY, handleRequest); - - // attach class request handler - classWebServer.on("/example", HTTP_ANY, std::bind(&WebClass::classRequest, this, std::placeholders::_1)); - } -}; - -AsyncWebServer globalWebServer(80); -WebClass webClassInstance; - -void setup() { - // attach global request handler - globalWebServer.on("/example", HTTP_ANY, handleRequest); - - // attach class request handler - globalWebServer.on("/example", HTTP_ANY, std::bind(&WebClass::classRequest, webClassInstance, std::placeholders::_1)); -} - -void loop() { - -} -``` - -#### Methods for controlling websocket connections - -```cpp - // Disable client connections if it was activated - if ( ws.enabled() ) - ws.enable(false); - - // enable client connections if it was disabled - if ( !ws.enabled() ) - ws.enable(true); -``` - -Example of OTA code - -```cpp - // OTA callbacks - ArduinoOTA.onStart([]() { - // Clean SPIFFS - SPIFFS.end(); - - // Disable client connections - ws.enable(false); - - // Advertise connected clients what's going on - ws.textAll("OTA Update Started"); - - // Close them - ws.closeAll(); - - }); - -``` - -#### Adding Default Headers - -In some cases, such as when working with CORS, or with some sort of custom authentication system, -you might need to define a header that should get added to all responses (including static, websocket and EventSource). -The DefaultHeaders singleton allows you to do this. - -Example: - -```cpp -DefaultHeaders::Instance().addHeader("Access-Control-Allow-Origin", "*"); -webServer.begin(); -``` - -_NOTE_: You will still need to respond to the OPTIONS method for CORS pre-flight in most cases. (unless you are only using GET) - -This is one option: - -```cpp -webServer.onNotFound([](AsyncWebServerRequest *request) { - if (request->method() == HTTP_OPTIONS) { - request->send(200); - } else { - request->send(404); - } -}); -``` - -#### Path variable - -With path variable you can create a custom regex rule for a specific parameter in a route. -For example we want a `sensorId` parameter in a route rule to match only a integer. - -```cpp - server.on("^\\/sensor\\/([0-9]+)$", HTTP_GET, [] (AsyncWebServerRequest *request) { - String sensorId = request->pathArg(0); - }); -``` - -_NOTE_: All regex patterns starts with `^` and ends with `$` - -To enable the `Path variable` support, you have to define the buildflag `-DASYNCWEBSERVER_REGEX`. - -For Arduino IDE create/update `platform.local.txt`: - -`Windows`: C:\Users\(username)\AppData\Local\Arduino15\packages\\`{espxxxx}`\hardware\\`espxxxx`\\`{version}`\platform.local.txt - -`Linux`: ~/.arduino15/packages/`{espxxxx}`/hardware/`{espxxxx}`/`{version}`/platform.local.txt - -Add/Update the following line: - -``` - compiler.cpp.extra_flags=-DDASYNCWEBSERVER_REGEX -``` - -For platformio modify `platformio.ini`: - -```ini -[env:myboard] -build_flags = - -DASYNCWEBSERVER_REGEX -``` - -_NOTE_: By enabling `ASYNCWEBSERVER_REGEX`, `` will be included. This will add an 100k to your binary. +If you need to serve chunk requests with a really low buffer (which should be avoided), you can set `-D ASYNCWEBSERVER_USE_CHUNK_INFLIGHT=0` to disable the in-flight control. diff --git a/data/README.md b/data/README.md new file mode 100644 index 0000000..96a2ee4 --- /dev/null +++ b/data/README.md @@ -0,0 +1,48 @@ +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod +rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper +arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit +accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. +Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo +dapibus elit, id varius sem dui id lacus. diff --git a/examples/Auth/Auth.ino b/examples/Auth/Auth.ino new file mode 100644 index 0000000..c3751e0 --- /dev/null +++ b/examples/Auth/Auth.ino @@ -0,0 +1,157 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Authentication and authorization middlewares +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +// basicAuth +static AsyncAuthenticationMiddleware basicAuth; +static AsyncAuthenticationMiddleware basicAuthHash; + +// simple digest authentication +static AsyncAuthenticationMiddleware digestAuth; +static AsyncAuthenticationMiddleware digestAuthHash; + +// complex authentication which adds request attributes for the next middlewares and handler +static AsyncMiddlewareFunction complexAuth([](AsyncWebServerRequest *request, ArMiddlewareNext next) { + if (!request->authenticate("user", "password")) { + return request->requestAuthentication(); + } + + // add attributes to the request for the next middlewares and handler + request->setAttribute("user", "Mathieu"); + request->setAttribute("role", "staff"); + if (request->hasParam("token")) { + request->setAttribute("token", request->getParam("token")->value().c_str()); + } + + next(); +}); + +static AsyncAuthorizationMiddleware authz([](AsyncWebServerRequest *request) { + return request->getAttribute("token") == "123"; +}); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // basic authentication + basicAuth.setUsername("admin"); + basicAuth.setPassword("admin"); + basicAuth.setRealm("MyApp"); + basicAuth.setAuthFailureMessage("Authentication failed"); + basicAuth.setAuthType(AsyncAuthType::AUTH_BASIC); + basicAuth.generateHash(); // precompute hash (optional but recommended) + + // basic authentication with hash + basicAuthHash.setUsername("admin"); + basicAuthHash.setPasswordHash("YWRtaW46YWRtaW4="); // BASE64(admin:admin) + basicAuthHash.setRealm("MyApp"); + basicAuthHash.setAuthFailureMessage("Authentication failed"); + basicAuthHash.setAuthType(AsyncAuthType::AUTH_BASIC); + + // digest authentication + digestAuth.setUsername("admin"); + digestAuth.setPassword("admin"); + digestAuth.setRealm("MyApp"); + digestAuth.setAuthFailureMessage("Authentication failed"); + digestAuth.setAuthType(AsyncAuthType::AUTH_DIGEST); + digestAuth.generateHash(); // precompute hash (optional but recommended) + + // digest authentication with hash + digestAuthHash.setUsername("admin"); + digestAuthHash.setPasswordHash("f499b71f9a36d838b79268e145e132f7"); // MD5(user:realm:pass) + digestAuthHash.setRealm("MyApp"); + digestAuthHash.setAuthFailureMessage("Authentication failed"); + digestAuthHash.setAuthType(AsyncAuthType::AUTH_DIGEST); + + // basic authentication method + // curl -v -u admin:admin http://192.168.4.1/auth-basic + server + .on( + "/auth-basic", HTTP_GET, + [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + } + ) + .addMiddleware(&basicAuth); + + // basic authentication method with hash + // curl -v -u admin:admin http://192.168.4.1/auth-basic-hash + server + .on( + "/auth-basic-hash", HTTP_GET, + [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + } + ) + .addMiddleware(&basicAuthHash); + + // digest authentication + // curl -v -u admin:admin --digest http://192.168.4.1/auth-digest + server + .on( + "/auth-digest", HTTP_GET, + [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + } + ) + .addMiddleware(&digestAuth); + + // digest authentication with hash + // curl -v -u admin:admin --digest http://192.168.4.1/auth-digest-hash + server + .on( + "/auth-digest-hash", HTTP_GET, + [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + } + ) + .addMiddleware(&digestAuthHash); + + // test digest auth custom authorization middleware + // curl -v --digest -u user:password http://192.168.4.1/auth-custom?token=123 => OK + // curl -v --digest -u user:password http://192.168.4.1/auth-custom?token=456 => 403 + // curl -v --digest -u user:FAILED http://192.168.4.1/auth-custom?token=456 => 401 + server + .on( + "/auth-custom", HTTP_GET, + [](AsyncWebServerRequest *request) { + String buffer = "Hello "; + buffer.concat(request->getAttribute("user")); + buffer.concat(" with role: "); + buffer.concat(request->getAttribute("role")); + request->send(200, "text/plain", buffer); + } + ) + .addMiddlewares({&complexAuth, &authz}); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/CORS/CORS.ino b/examples/CORS/CORS.ino new file mode 100644 index 0000000..3be46fd --- /dev/null +++ b/examples/CORS/CORS.ino @@ -0,0 +1,60 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// How to use CORS middleware +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); +static AsyncCorsMiddleware cors; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + cors.setOrigin("http://192.168.4.1"); + cors.setMethods("POST, GET, OPTIONS, DELETE"); + cors.setHeaders("X-Custom-Header"); + cors.setAllowCredentials(false); + cors.setMaxAge(600); + + server.addMiddleware(&cors); + + // Test CORS preflight request + // curl -v -X OPTIONS -H "origin: http://192.168.4.1" http://192.168.4.1/cors + // + // Test CORS request + // curl -v -H "origin: http://192.168.4.1" http://192.168.4.1/cors + // + // Test non-CORS request + // curl -v http://192.168.4.1/cors + // + server.on("/cors", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/CaptivePortal/CaptivePortal.ino b/examples/CaptivePortal/CaptivePortal.ino index 69232d8..a872a9b 100644 --- a/examples/CaptivePortal/CaptivePortal.ino +++ b/examples/CaptivePortal/CaptivePortal.ino @@ -1,36 +1,39 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #include #ifdef ESP32 - #include - #include +#include +#include #elif defined(ESP8266) - #include - #include -#elif defined(TARGET_RP2040) - #include - #include +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include #endif #include "ESPAsyncWebServer.h" -DNSServer dnsServer; -AsyncWebServer server(80); +static DNSServer dnsServer; +static AsyncWebServer server(80); class CaptiveRequestHandler : public AsyncWebHandler { - public: - bool canHandle(__unused AsyncWebServerRequest* request) const override { - return true; - } +public: + bool canHandle(__unused AsyncWebServerRequest *request) const override { + return true; + } - void handleRequest(AsyncWebServerRequest* request) { - AsyncResponseStream* response = request->beginResponseStream("text/html"); - response->print("Captive Portal"); - response->print("

This is out captive portal front page.

"); - response->printf("

You were trying to reach: http://%s%s

", request->host().c_str(), request->url().c_str()); + void handleRequest(AsyncWebServerRequest *request) { + AsyncResponseStream *response = request->beginResponseStream("text/html"); + response->print("Captive Portal"); + response->print("

This is our captive portal front page.

"); + response->printf("

You were trying to reach: http://%s%s

", request->host().c_str(), request->url().c_str()); #ifndef CONFIG_IDF_TARGET_ESP32H2 - response->printf("

Try opening this link instead

", WiFi.softAPIP().toString().c_str()); + response->printf("

Try opening this link instead

", WiFi.softAPIP().toString().c_str()); #endif - response->print(""); - request->send(response); - } + response->print(""); + request->send(response); + } }; void setup() { @@ -41,14 +44,13 @@ void setup() { #ifndef CONFIG_IDF_TARGET_ESP32H2 if (!WiFi.softAP("esp-captive")) { Serial.println("Soft AP creation failed."); - while (1) - ; + while (1); } dnsServer.start(53, "*", WiFi.softAPIP()); #endif - server.addHandler(new CaptiveRequestHandler()).setFilter(ON_AP_FILTER); // only when requested from AP + server.addHandler(new CaptiveRequestHandler()).setFilter(ON_AP_FILTER); // only when requested from AP // more handlers... server.begin(); } diff --git a/examples/CatchAllHandler/CatchAllHandler.ino b/examples/CatchAllHandler/CatchAllHandler.ino new file mode 100644 index 0000000..42a3698 --- /dev/null +++ b/examples/CatchAllHandler/CatchAllHandler.ino @@ -0,0 +1,133 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to catch all requests and send a 404 Not Found response +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + // catch any request, and send a 404 Not Found response + // except for /game_log which is handled by onRequestBody + // + // curl -v http://192.168.4.1/foo + // + server.onNotFound([](AsyncWebServerRequest *request) { + if (request->url() == "/game_log") { + return; // response object already created by onRequestBody + } + + request->send(404, "text/plain", "Not found"); + }); + + // See: https://github.com/ESP32Async/ESPAsyncWebServer/issues/6 + // catch any POST request and send a 200 OK response + // + // curl -v -X POST http://192.168.4.1/game_log -H "Content-Type: application/json" -d '{"game": "test"}' + // + server.onRequestBody([](AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) { + if (request->url() == "/game_log") { + request->send(200, "application/json", "{\"status\":\"OK\"}"); + } + // note that there is no else here: the goal is only to prepare a response based on some body content + // onNotFound will always be called after this, and will not override the response object if `/game_log` is requested + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/ChunkResponse/ChunkResponse.ino b/examples/ChunkResponse/ChunkResponse.ino new file mode 100644 index 0000000..e7d4838 --- /dev/null +++ b/examples/ChunkResponse/ChunkResponse.ino @@ -0,0 +1,140 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Chunk response with caching example +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // first time: serves the file and cache headers + // curl -N -v http://192.168.4.1/ --output - + // + // secodn time: serves 304 + // curl -N -v -H "if-none-match: 4272" http://192.168.4.1/ --output - + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + String etag = String(htmlContentLength); + + if (request->header(asyncsrv::T_INM) == etag) { + request->send(304); + return; + } + + AsyncWebServerResponse *response = request->beginChunkedResponse("text/html", [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { + Serial.printf("%u / %u\n", index, htmlContentLength); + + // finished ? + if (htmlContentLength <= index) { + Serial.println("finished"); + return 0; + } + + // serve a maximum of 256 or maxLen bytes of the remaining content + // this small number is specifically chosen to demonstrate the chunking + // DO NOT USE SUCH SMALL NUMBER IN PRODUCTION + // Reducing the chunk size will increase the response time, thus reducing the server's capacity in processing concurrent requests + const int chunkSize = min((size_t)256, min(maxLen, htmlContentLength - index)); + Serial.printf("sending: %u\n", chunkSize); + + memcpy(buffer, htmlContent + index, chunkSize); + + return chunkSize; + }); + + response->addHeader(asyncsrv::T_Cache_Control, "public,max-age=60"); + response->addHeader(asyncsrv::T_ETag, etag); + + request->send(response); + }); + + server.begin(); +} + +void loop() { + delay(100); +} diff --git a/examples/ChunkRetryResponse/ChunkRetryResponse.ino b/examples/ChunkRetryResponse/ChunkRetryResponse.ino new file mode 100644 index 0000000..48772cc --- /dev/null +++ b/examples/ChunkRetryResponse/ChunkRetryResponse.ino @@ -0,0 +1,216 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to wait in a chunk response for incoming data +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +#if __has_include("ArduinoJson.h") +#include +#include +#include +#endif + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +static AsyncWebServer server(80); +static AsyncLoggingMiddleware requestLogger; + +static String triggerUART; +static int key = -1; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // adds some internal request logging for debugging + requestLogger.setEnabled(true); + requestLogger.setOutput(Serial); + + server.addMiddleware(&requestLogger); + +#if __has_include("ArduinoJson.h") + + // + // HOW TO RUN THIS EXAMPLE: + // + // 1. Trigger a request that will be blocked for a long time: + // > time curl -v -X POST http://192.168.4.1/api -H "Content-Type: application/json" -d '{"input": "Please type a key to continue in Serial console..."}' --output - + // + // 2. While waiting, in another terminal, run some concurrent requests: + // > time curl -v http://192.168.4.1/ + // + // 3. Type a key in the Serial console to continue the processing within 30 seconds. + // This should unblock the first request. + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + server.on( + "/api", HTTP_POST, + [](AsyncWebServerRequest *request) { + // request parsing has finished + + // no data ? + if (!((String *)request->_tempObject)->length()) { + request->send(400); + return; + } + + JsonDocument doc; + + // deserialize and check for errors + if (deserializeJson(doc, *(String *)request->_tempObject)) { + request->send(400); + return; + } + + // start UART com: UART will send the data to the Serial console and wait for the key press + triggerUART = doc["input"].as(); + key = -1; + + AsyncWebServerResponse *response = request->beginChunkedResponse("text/plain", [](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { + // still waiting for UARY ? + if (triggerUART.length() && key == -1) { + return RESPONSE_TRY_AGAIN; + } + + // finished ? + if (!triggerUART.length() && key == -1) { + return 0; // 0 means we are done + } + + // log_d("UART answered!"); + + String answer = "You typed: "; + answer.concat((char)key); + + // note: I did not check for maxLen, but you should (see ChunkResponse.ino) + memcpy(buffer, answer.c_str(), answer.length()); + + // finish! + triggerUART = emptyString; + key = -1; + + return answer.length(); + }); + + request->send(response); + }, + NULL, // upload handler is not used so it should be NULL + [](AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) { + // log_d("Body: index: %u, len: %u, total: %u", index, len, total); + + if (!index) { + // log_d("Start body parsing"); + request->_tempObject = new String(); + // cast request->_tempObject pointer to String and reserve total size + ((String *)request->_tempObject)->reserve(total); + // set timeout 30s + request->client()->setRxTimeout(30); + } + + // log_d("Append body data"); + ((String *)request->_tempObject)->concat((const char *)data, len); + } + ); + +#endif + + server.begin(); +} + +void loop() { + if (triggerUART.length() && key == -1) { + Serial.println(triggerUART); + // log_d("Waiting for UART input..."); + while (!Serial.available()) { + delay(100); + } + key = Serial.read(); + Serial.flush(); + // log_d("UART input: %c", key); + triggerUART = emptyString; + } +} diff --git a/examples/EndBegin/EndBegin.ino b/examples/EndBegin/EndBegin.ino new file mode 100644 index 0000000..acfc6ff --- /dev/null +++ b/examples/EndBegin/EndBegin.ino @@ -0,0 +1,49 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// https://github.com/ESP32Async/ESPAsyncWebServer/discussions/23 +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world"); + }); + + server.begin(); + Serial.println("begin() - run: curl -v http://192.168.4.1/ => should succeed"); + delay(10000); + + Serial.println("end()"); + server.end(); + server.begin(); + Serial.println("begin() - run: curl -v http://192.168.4.1/ => should succeed"); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/Filters/Filters.ino b/examples/Filters/Filters.ino index c29103b..519478c 100644 --- a/examples/Filters/Filters.ino +++ b/examples/Filters/Filters.ino @@ -1,38 +1,43 @@ -// Reproduced issue https://github.com/ESP32Async/ESPAsyncWebServer/issues/26 +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to use setFilter to route requests to different handlers based on WiFi mode +// #include #ifdef ESP32 - #include - #include +#include +#include #elif defined(ESP8266) - #include - #include -#elif defined(TARGET_RP2040) - #include - #include +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include #endif #include "ESPAsyncWebServer.h" -DNSServer dnsServer; -AsyncWebServer server(80); +static DNSServer dnsServer; +static AsyncWebServer server(80); class CaptiveRequestHandler : public AsyncWebHandler { - public: - bool canHandle(__unused AsyncWebServerRequest* request) const override { - return true; - } +public: + bool canHandle(__unused AsyncWebServerRequest *request) const override { + return true; + } - void handleRequest(AsyncWebServerRequest* request) override { - AsyncResponseStream* response = request->beginResponseStream("text/html"); - response->print("Captive Portal"); - response->print("

This is out captive portal front page.

"); - response->printf("

You were trying to reach: http://%s%s

", request->host().c_str(), request->url().c_str()); + void handleRequest(AsyncWebServerRequest *request) override { + AsyncResponseStream *response = request->beginResponseStream("text/html"); + response->print("Captive Portal"); + response->print("

This is out captive portal front page.

"); + response->printf("

You were trying to reach: http://%s%s

", request->host().c_str(), request->url().c_str()); #ifndef CONFIG_IDF_TARGET_ESP32H2 - response->printf("

Try opening this link instead

", WiFi.softAPIP().toString().c_str()); + response->printf("

Try opening this link instead

", WiFi.softAPIP().toString().c_str()); #endif - response->print(""); - request->send(response); - } + response->print(""); + request->send(response); + } }; bool hit1 = false; @@ -42,49 +47,55 @@ void setup() { Serial.begin(115200); server - .on("/", HTTP_GET, [](AsyncWebServerRequest* request) { - Serial.println("Captive portal request..."); + .on( + "/", HTTP_GET, + [](AsyncWebServerRequest *request) { + Serial.println("Captive portal request..."); #ifndef CONFIG_IDF_TARGET_ESP32H2 - Serial.println("WiFi.localIP(): " + WiFi.localIP().toString()); + Serial.println("WiFi.localIP(): " + WiFi.localIP().toString()); #endif - Serial.println("request->client()->localIP(): " + request->client()->localIP().toString()); + Serial.println("request->client()->localIP(): " + request->client()->localIP().toString()); #if ESP_IDF_VERSION_MAJOR >= 5 - #ifndef CONFIG_IDF_TARGET_ESP32H2 - Serial.println("WiFi.type(): " + String((int)WiFi.localIP().type())); - #endif - Serial.println("request->client()->type(): " + String((int)request->client()->localIP().type())); +#ifndef CONFIG_IDF_TARGET_ESP32H2 + Serial.println("WiFi.type(): " + String((int)WiFi.localIP().type())); +#endif + Serial.println("request->client()->type(): " + String((int)request->client()->localIP().type())); #endif #ifndef CONFIG_IDF_TARGET_ESP32H2 - Serial.println(WiFi.localIP() == request->client()->localIP() ? "should be: ON_STA_FILTER" : "should be: ON_AP_FILTER"); - Serial.println(WiFi.localIP() == request->client()->localIP()); - Serial.println(WiFi.localIP().toString() == request->client()->localIP().toString()); + Serial.println(WiFi.localIP() == request->client()->localIP() ? "should be: ON_STA_FILTER" : "should be: ON_AP_FILTER"); + Serial.println(WiFi.localIP() == request->client()->localIP()); + Serial.println(WiFi.localIP().toString() == request->client()->localIP().toString()); #endif - request->send(200, "text/plain", "This is the captive portal"); - hit1 = true; - }) + request->send(200, "text/plain", "This is the captive portal"); + hit1 = true; + } + ) .setFilter(ON_AP_FILTER); server - .on("/", HTTP_GET, [](AsyncWebServerRequest* request) { - Serial.println("Website request..."); + .on( + "/", HTTP_GET, + [](AsyncWebServerRequest *request) { + Serial.println("Website request..."); #ifndef CONFIG_IDF_TARGET_ESP32H2 - Serial.println("WiFi.localIP(): " + WiFi.localIP().toString()); + Serial.println("WiFi.localIP(): " + WiFi.localIP().toString()); #endif - Serial.println("request->client()->localIP(): " + request->client()->localIP().toString()); + Serial.println("request->client()->localIP(): " + request->client()->localIP().toString()); #if ESP_IDF_VERSION_MAJOR >= 5 - #ifndef CONFIG_IDF_TARGET_ESP32H2 - Serial.println("WiFi.type(): " + String((int)WiFi.localIP().type())); - #endif - Serial.println("request->client()->type(): " + String((int)request->client()->localIP().type())); +#ifndef CONFIG_IDF_TARGET_ESP32H2 + Serial.println("WiFi.type(): " + String((int)WiFi.localIP().type())); +#endif + Serial.println("request->client()->type(): " + String((int)request->client()->localIP().type())); #endif #ifndef CONFIG_IDF_TARGET_ESP32H2 - Serial.println(WiFi.localIP() == request->client()->localIP() ? "should be: ON_STA_FILTER" : "should be: ON_AP_FILTER"); - Serial.println(WiFi.localIP() == request->client()->localIP()); - Serial.println(WiFi.localIP().toString() == request->client()->localIP().toString()); + Serial.println(WiFi.localIP() == request->client()->localIP() ? "should be: ON_STA_FILTER" : "should be: ON_AP_FILTER"); + Serial.println(WiFi.localIP() == request->client()->localIP()); + Serial.println(WiFi.localIP().toString() == request->client()->localIP().toString()); #endif - request->send(200, "text/plain", "This is the website"); - hit2 = true; - }) + request->send(200, "text/plain", "This is the website"); + hit2 = true; + } + ) .setFilter(ON_STA_FILTER); // assert(WiFi.softAP("esp-captive-portal")); @@ -121,4 +132,5 @@ void setup() { } void loop() { + delay(100); } diff --git a/examples/FlashResponse/FlashResponse.ino b/examples/FlashResponse/FlashResponse.ino new file mode 100644 index 0000000..6948cd2 --- /dev/null +++ b/examples/FlashResponse/FlashResponse.ino @@ -0,0 +1,107 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to serve a large HTML page from flash memory without copying it to heap in a temporary buffer +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/HeaderManipulation/HeaderManipulation.ino b/examples/HeaderManipulation/HeaderManipulation.ino new file mode 100644 index 0000000..4fe34dc --- /dev/null +++ b/examples/HeaderManipulation/HeaderManipulation.ino @@ -0,0 +1,88 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Show how to manipulate headers in the request / response +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +// request logger +static AsyncLoggingMiddleware requestLogger; + +// filter out specific headers from the incoming request +static AsyncHeaderFilterMiddleware headerFilter; + +// remove all headers from the incoming request except the ones provided in the constructor +AsyncHeaderFreeMiddleware headerFree; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + requestLogger.setEnabled(true); + requestLogger.setOutput(Serial); + + headerFilter.filter("X-Remove-Me"); + + headerFree.keep("X-Keep-Me"); + headerFree.keep("host"); + + server.addMiddlewares({&requestLogger, &headerFilter}); + + // x-remove-me header will be removed + // + // curl -v -H "X-Header: Foo" -H "x-remove-me: value" http://192.168.4.1/remove + // + server.on("/remove", HTTP_GET, [](AsyncWebServerRequest *request) { + // print all headers + for (size_t i = 0; i < request->headers(); i++) { + const AsyncWebHeader *h = request->getHeader(i); + Serial.printf("Header[%s]: %s\n", h->name().c_str(), h->value().c_str()); + } + request->send(200, "text/plain", "Hello, world!"); + }); + + // Only headers x-keep-me and host will be kept + // + // curl -v -H "x-keep-me: value" -H "x-remove-me: value" http://192.168.4.1/keep + // + server + .on( + "/keep", HTTP_GET, + [](AsyncWebServerRequest *request) { + // print all headers + for (size_t i = 0; i < request->headers(); i++) { + const AsyncWebHeader *h = request->getHeader(i); + Serial.printf("Header[%s]: %s\n", h->name().c_str(), h->value().c_str()); + } + request->send(200, "text/plain", "Hello, world!"); + } + ) + .addMiddleware(&headerFree); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/Headers/Headers.ino b/examples/Headers/Headers.ino new file mode 100644 index 0000000..e07c515 --- /dev/null +++ b/examples/Headers/Headers.ino @@ -0,0 +1,69 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Query and send headers +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // + // curl -v http://192.168.4.1 + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + //List all collected headers + int headers = request->headers(); + int i; + for (i = 0; i < headers; i++) { + const AsyncWebHeader *h = request->getHeader(i); + Serial.printf("HEADER[%s]: %s\n", h->name().c_str(), h->value().c_str()); + } + + AsyncWebServerResponse *response = request->beginResponse(200, "text/plain", "Hello World!"); + + //Add header to the response + response->addHeader("Server", "ESP Async Web Server"); + + //Add multiple headers with the same name + response->addHeader("Set-Cookie", "sessionId=38afes7a8", false); + response->addHeader("Set-Cookie", "id=a3fWa; Max-Age=2592000", false); + response->addHeader("Set-Cookie", "qwerty=219ffwef9w0f; Domain=example.com", false); + + //Remove specific header + response->removeHeader("Set-Cookie", "sessionId=38afes7a8"); + + //Remove all headers with the same name + response->removeHeader("Set-Cookie"); + + request->send(response); + }); + + server.begin(); +} + +void loop() { + //Sleep in the loop task to not keep the CPU busy + delay(1000); +} diff --git a/examples/Issue162/Issue162.ino b/examples/Issue162/Issue162.ino deleted file mode 100644 index adc82d9..0000000 --- a/examples/Issue162/Issue162.ino +++ /dev/null @@ -1,99 +0,0 @@ -/** - * - * Connect to AP and run in bash: - * - * > while true; do echo "PING"; sleep 0.1; done | websocat ws://192.168.4.1/ws - * - */ -#include -#ifdef ESP8266 - #include -#endif -#ifdef ESP32 - #include -#endif -#include - -#include -AsyncWebServer server(80); -AsyncWebSocket ws("/ws"); - -void onWsEvent(AsyncWebSocket* server, AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len) { - if (type == WS_EVT_CONNECT) { - Serial.printf("Client #%" PRIu32 " connected.\n", client->id()); - } else if (type == WS_EVT_DISCONNECT) { - Serial.printf("Client #%" PRIu32 " disconnected.\n", client->id()); - } else if (type == WS_EVT_ERROR) { - Serial.printf("Client #%" PRIu32 " error.\n", client->id()); - } else if (type == WS_EVT_DATA) { - Serial.printf("Client #%" PRIu32 " len: %u\n", client->id(), len); - } else if (type == WS_EVT_PONG) { - Serial.printf("Client #%" PRIu32 " pong.\n", client->id()); - } else if (type == WS_EVT_PING) { - Serial.printf("Client #%" PRIu32 " ping.\n", client->id()); - } -} - -void setup() { - Serial.begin(115200); - - WiFi.mode(WIFI_AP); - WiFi.softAP("esp-captive"); - - ws.onEvent(onWsEvent); - server.addHandler(&ws); - - server.on("/close_all_ws_clients", HTTP_GET | HTTP_POST, [](AsyncWebServerRequest* request) { - Serial.println("Closing all WebSocket clients..."); - ws.closeAll(); - request->send(200, "application/json", "{\"status\":\"all clients closed\"}"); - }); - - server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/html", R"rawliteral( - - - - - -

- - - )rawliteral"); - }); - - server.begin(); -} - -uint32_t lastTime = 0; -void loop() { - if (millis() - lastTime > 5000) { - lastTime = millis(); - Serial.printf("Client count: %u\n", ws.count()); - } - ws.cleanupClients(); -} diff --git a/examples/Issue85/Issue85.ino b/examples/Issue85/Issue85.ino deleted file mode 100644 index fa2aa55..0000000 --- a/examples/Issue85/Issue85.ino +++ /dev/null @@ -1,127 +0,0 @@ -/** - * - * Connect to AP and run in bash: - * - * > while true; do echo "PING"; sleep 0.1; done | websocat ws://192.168.4.1/ws - * - */ -#include -#ifdef ESP8266 - #include -#endif -#ifdef ESP32 - #include -#endif -#include - -#include - -size_t msgCount = 0; -size_t window = 100; -std::list times; - -void connect_wifi() { - WiFi.mode(WIFI_AP); - WiFi.softAP("esp-captive"); - - // Serial.print("Connecting"); - // while (WiFi.status() != WL_CONNECTED) { - // delay(500); - // Serial.print("."); - // } - // Serial.println(); - - // Serial.print("Connected, IP address: "); - // Serial.println(WiFi.localIP()); -} - -void notFound(AsyncWebServerRequest* request) { - request->send(404, "text/plain", "Not found"); -} - -AsyncWebServer server(80); -AsyncWebSocket ws("/ws"); - -// initial stack -char* stack_start; - -void printStackSize() { - char stack; - Serial.print(F("stack size ")); - Serial.print(stack_start - &stack); - Serial.print(F(" | Heap free:")); - Serial.print(ESP.getFreeHeap()); -#ifdef ESP8266 - Serial.print(F(" frag:")); - Serial.print(ESP.getHeapFragmentation()); - Serial.print(F(" maxFreeBlock:")); - Serial.print(ESP.getMaxFreeBlockSize()); -#endif - Serial.println(); -} - -void onWsEventEmpty(AsyncWebSocket* server, AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len) { - msgCount++; - Serial.printf("count: %d\n", msgCount); - - times.push_back(millis()); - while (times.size() > window) - times.pop_front(); - if (times.size() == window) - Serial.printf("%f req/s\n", 1000.0 * window / (times.back() - times.front())); - - printStackSize(); - - client->text("PONG"); -} - -void serve_upload(AsyncWebServerRequest* request, const String& filename, size_t index, uint8_t* data, size_t len, bool final) { - Serial.print("> onUpload "); - Serial.print("index: "); - Serial.print(index); - Serial.print(" len:"); - Serial.print(len); - Serial.print(" final:"); - Serial.print(final); - Serial.println(); -} - -void setup() { - char stack; - stack_start = &stack; - - Serial.begin(115200); - Serial.println("\n\n\nStart"); - Serial.printf("stack_start: %p\n", stack_start); - - connect_wifi(); - - server.onNotFound(notFound); - - ws.onEvent(onWsEventEmpty); - server.addHandler(&ws); - - server.on("/upload", HTTP_POST, [](AsyncWebServerRequest* request) { request->send(200); }, serve_upload); - - server.begin(); - Serial.println("Server started"); -} - -String msg = ""; -uint32_t count = 0; -void loop() { - // ws.cleanupClients(); - // count += 1; - // // Concatenate some string, and clear it after some time - // static unsigned long millis_string = millis(); - // if (millis() - millis_string > 1) { - // millis_string += 100; - // if (count % 100 == 0) { - // // printStackSize(); - // // Serial.print(msg); - // msg = String(); - // } else { - // msg += 'T'; - // } - // } -} \ No newline at end of file diff --git a/examples/Json/Json.ino b/examples/Json/Json.ino new file mode 100644 index 0000000..0ea8892 --- /dev/null +++ b/examples/Json/Json.ino @@ -0,0 +1,90 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to send and receive Json data +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +#if __has_include("ArduinoJson.h") +#include +#include +#include +#endif + +static AsyncWebServer server(80); + +#if __has_include("ArduinoJson.h") +static AsyncCallbackJsonWebHandler *handler = new AsyncCallbackJsonWebHandler("/json2"); +#endif + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + +#if __has_include("ArduinoJson.h") + // + // sends JSON using AsyncJsonResponse + // + // curl -v http://192.168.4.1/json1 + // + server.on("/json1", HTTP_GET, [](AsyncWebServerRequest *request) { + AsyncJsonResponse *response = new AsyncJsonResponse(); + JsonObject root = response->getRoot().to(); + root["hello"] = "world"; + response->setLength(); + request->send(response); + }); + + // Send JSON using AsyncResponseStream + // + // curl -v http://192.168.4.1/json2 + // + server.on("/json2", HTTP_GET, [](AsyncWebServerRequest *request) { + AsyncResponseStream *response = request->beginResponseStream("application/json"); + JsonDocument doc; + JsonObject root = doc.to(); + root["foo"] = "bar"; + serializeJson(root, *response); + request->send(response); + }); + + // curl -v -X POST -H 'Content-Type: application/json' -d '{"name":"You"}' http://192.168.4.1/json2 + // curl -v -X PUT -H 'Content-Type: application/json' -d '{"name":"You"}' http://192.168.4.1/json2 + handler->setMethod(HTTP_POST | HTTP_PUT); + handler->onRequest([](AsyncWebServerRequest *request, JsonVariant &json) { + serializeJson(json, Serial); + AsyncJsonResponse *response = new AsyncJsonResponse(); + JsonObject root = response->getRoot().to(); + root["hello"] = json.as()["name"]; + response->setLength(); + request->send(response); + }); + + server.addHandler(handler); +#endif + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/Logging/Logging.ino b/examples/Logging/Logging.ino new file mode 100644 index 0000000..6485185 --- /dev/null +++ b/examples/Logging/Logging.ino @@ -0,0 +1,49 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Show how to log the incoming request and response as a curl-like syntax +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); +static AsyncLoggingMiddleware requestLogger; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + requestLogger.setEnabled(true); + requestLogger.setOutput(Serial); + + server.addMiddleware(&requestLogger); + + // curl -v -H "X-Header:Foo" http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/MessagePack/MessagePack.ino b/examples/MessagePack/MessagePack.ino new file mode 100644 index 0000000..4fea247 --- /dev/null +++ b/examples/MessagePack/MessagePack.ino @@ -0,0 +1,88 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to send and receive Message Pack data +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +#if __has_include("ArduinoJson.h") +#include +#include +#include +#endif + +static AsyncWebServer server(80); + +#if __has_include("ArduinoJson.h") +static AsyncCallbackMessagePackWebHandler *handler = new AsyncCallbackMessagePackWebHandler("/msgpack2"); +#endif + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + +#if __has_include("ArduinoJson.h") + // + // sends MessagePack using AsyncMessagePackResponse + // + // curl -v http://192.168.4.1/msgpack1 + // + server.on("/msgpack1", HTTP_GET, [](AsyncWebServerRequest *request) { + AsyncMessagePackResponse *response = new AsyncMessagePackResponse(); + JsonObject root = response->getRoot().to(); + root["hello"] = "world"; + response->setLength(); + request->send(response); + }); + + // Send MessagePack using AsyncResponseStream + // + // curl -v http://192.168.4.1/msgpack2 + // + server.on("/msgpack2", HTTP_GET, [](AsyncWebServerRequest *request) { + AsyncResponseStream *response = request->beginResponseStream("application/msgpack"); + JsonDocument doc; + JsonObject root = doc.to(); + root["foo"] = "bar"; + serializeMsgPack(root, *response); + request->send(response); + }); + + handler->setMethod(HTTP_POST | HTTP_PUT); + handler->onRequest([](AsyncWebServerRequest *request, JsonVariant &json) { + serializeJson(json, Serial); + AsyncMessagePackResponse *response = new AsyncMessagePackResponse(); + JsonObject root = response->getRoot().to(); + root["hello"] = json.as()["name"]; + response->setLength(); + request->send(response); + }); + + server.addHandler(handler); +#endif + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/Middleware/Middleware.ino b/examples/Middleware/Middleware.ino new file mode 100644 index 0000000..c52f949 --- /dev/null +++ b/examples/Middleware/Middleware.ino @@ -0,0 +1,82 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Show how to sue Middleware +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +// New middleware classes can be created! +class MyMiddleware : public AsyncMiddleware { +public: + void run(AsyncWebServerRequest *request, ArMiddlewareNext next) override { + Serial.printf("Before handler: %s %s\n", request->methodToString(), request->url().c_str()); + next(); // continue middleware chain + Serial.printf("After handler: response code=%d\n", request->getResponse()->code()); + } +}; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // add a global middleware to the server + server.addMiddleware(new MyMiddleware()); + + // Test with: + // + // - curl -v http://192.168.4.1/ => 200 OK + // - curl -v http://192.168.4.1/?user=anon => 403 Forbidden + // - curl -v http://192.168.4.1/?user=foo => 200 OK + // - curl -v http://192.168.4.1/?user=error => 400 ERROR + // + AsyncCallbackWebHandler &handler = server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + Serial.printf("In Handler: %s %s\n", request->methodToString(), request->url().c_str()); + request->send(200, "text/plain", "Hello, world!"); + }); + + // add a middleware to this handler only to send 403 if the user is anon + handler.addMiddleware([](AsyncWebServerRequest *request, ArMiddlewareNext next) { + Serial.println("Checking user=anon"); + if (request->hasParam("user") && request->getParam("user")->value() == "anon") { + request->send(403, "text/plain", "Forbidden"); + } else { + next(); + } + }); + + // add a middleware to this handler that will replace the previously created response by another one + handler.addMiddleware([](AsyncWebServerRequest *request, ArMiddlewareNext next) { + next(); + Serial.println("Checking user=error"); + if (request->hasParam("user") && request->getParam("user")->value() == "error") { + request->send(400, "text/plain", "ERROR"); + } + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/Params/Params.ino b/examples/Params/Params.ino new file mode 100644 index 0000000..2c438a5 --- /dev/null +++ b/examples/Params/Params.ino @@ -0,0 +1,122 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Query parameters and body parameters +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + + POST Request with Multiple Parameters + + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // Get query parameters + // + // curl -v http://192.168.4.1/?who=Bob + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + if (request->hasParam("who")) { + Serial.printf("Who? %s\n", request->getParam("who")->value().c_str()); + } + + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + // Get form body parameters + // + // curl -v -H "Content-Type: application/x-www-form-urlencoded" -d "who=Carl" -d "param=value" http://192.168.4.1/ + // + server.on("/", HTTP_POST, [](AsyncWebServerRequest *request) { + // display params + size_t count = request->params(); + for (size_t i = 0; i < count; i++) { + const AsyncWebParameter *p = request->getParam(i); + Serial.printf("PARAM[%u]: %s = %s\n", i, p->name().c_str(), p->value().c_str()); + } + + // get who param + String who; + if (request->hasParam("who", true)) { + who = request->getParam("who", true)->value(); + } else { + who = "No message sent"; + } + request->send(200, "text/plain", "Hello " + who + "!"); + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/PartitionDownloader/PartitionDownloader.ino b/examples/PartitionDownloader/PartitionDownloader.ino new file mode 100644 index 0000000..3c76366 --- /dev/null +++ b/examples/PartitionDownloader/PartitionDownloader.ino @@ -0,0 +1,130 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// - Download ESP32 partition by name and/or type and/or subtype +// - Support encrypted and non-encrypted partitions +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include +#include + +#ifndef ESP32 +// this example is only for the ESP32 +void setup() {} +void loop() {} +#else + +#include + +static AsyncWebServer server(80); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + LittleFS.begin(true); + + // To upload the FS partition, run: + // > pio run -e arduino-3 -t buildfs + // > pio run -e arduino-3 -t uploadfs + // + // Examples: + // + // - Download the partition named "spiffs": http://192.168.4.1/partition?label=spiffs + // - Download the partition named "spiffs" with type "data": http://192.168.4.1/partition?label=spiffs&type=1 + // - Download the partition named "spiffs" with type "data" and subtype "spiffs": http://192.168.4.1/partition?label=spiffs&type=1&subtype=130 + // - Download the partition with subtype "nvs": http://192.168.4.1/partition?type=1&subtype=2 + // + // "type" and "subtype" IDs can be found in esp_partition.h header file. + // + // Add "&raw=false" parameter to download the partition unencrypted (for encrypted partitions). + // By default, the raw partition is downloaded, so if a partition is encrypted, the encrypted data will be downloaded. + // + // To browse a downloaded LittleFS partition, you can use https://tniessen.github.io/littlefs-disk-img-viewer/ (block size is 4096) + // + server.on("/partition", HTTP_GET, [](AsyncWebServerRequest *request) { + const AsyncWebParameter *pLabel = request->getParam("label"); + const AsyncWebParameter *pType = request->getParam("type"); + const AsyncWebParameter *pSubtype = request->getParam("subtype"); + const AsyncWebParameter *pRaw = request->getParam("raw"); + + if (!pLabel && !pType && !pSubtype) { + request->send(400, "text/plain", "Bad request: missing parameter"); + return; + } + + esp_partition_type_t type = ESP_PARTITION_TYPE_ANY; + esp_partition_subtype_t subtype = ESP_PARTITION_SUBTYPE_ANY; + const char *label = nullptr; + bool raw = true; + + if (pLabel) { + label = pLabel->value().c_str(); + } + + if (pType) { + type = (esp_partition_type_t)pType->value().toInt(); + } + + if (pSubtype) { + subtype = (esp_partition_subtype_t)pSubtype->value().toInt(); + } + + if (pRaw && pRaw->value() == "false") { + raw = false; + } + + const esp_partition_t *partition = esp_partition_find_first(type, subtype, label); + + if (!partition) { + request->send(404, "text/plain", "Partition not found"); + return; + } + + AsyncWebServerResponse *response = + request->beginChunkedResponse("application/octet-stream", [partition, raw](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { + const size_t remaining = partition->size - index; + if (!remaining) { + return 0; + } + const size_t len = std::min(maxLen, remaining); + if (raw && esp_partition_read_raw(partition, index, buffer, len) == ESP_OK) { + return len; + } + if (!raw && esp_partition_read(partition, index, buffer, len) == ESP_OK) { + return len; + } + return 0; + }); + + response->addHeader("Content-Disposition", "attachment; filename=" + String(partition->label) + ".bin"); + response->setContentLength(partition->size); + + request->send(response); + }); + + server.begin(); +} + +void loop() { + delay(100); +} + +#endif diff --git a/examples/PerfTests/PerfTests.ino b/examples/PerfTests/PerfTests.ino new file mode 100644 index 0000000..047c7e3 --- /dev/null +++ b/examples/PerfTests/PerfTests.ino @@ -0,0 +1,243 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Perf tests +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); +static constexpr char characters[] = "0123456789ABCDEF"; +static size_t charactersIndex = 0; + +static AsyncWebServer server(80); +static AsyncEventSource events("/events"); + +static volatile size_t requests = 0; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // Pauses in the request parsing phase + // + // autocannon -c 32 -w 32 -a 96 -t 30 --renderStatusCodes -m POST -H "Content-Type: application/json" -b '{"foo": "bar"}' http://192.168.4.1/delay + // + // curl -v -X POST -H "Content-Type: application/json" -d '{"game": "test"}' http://192.168.4.1/delay + // + server.onNotFound([](AsyncWebServerRequest *request) { + requests++; + if (request->url() == "/delay") { + request->send(200, "application/json", "{\"status\":\"OK\"}"); + } else { + request->send(404, "text/plain", "Not found"); + } + }); + server.onRequestBody([](AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) { + if (request->url() == "/delay") { + delay(3000); + } + }); + + // HTTP endpoint + // + // > brew install autocannon + // > autocannon -c 10 -w 10 -d 20 http://192.168.4.1 + // > autocannon -c 16 -w 16 -d 20 http://192.168.4.1 + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + requests++; + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + // IMPORTANT - DO NOT WRITE SUCH CODE IN PRODUCTON ! + // + // This example simulates the slowdown that can happen when: + // - downloading a huge file from sdcard + // - doing some file listing on SDCard because it is horribly slow to get a file listing with file stats on SDCard. + // So in both cases, ESP would deadlock or TWDT would trigger. + // + // This example simulats that by slowing down the chunk callback: + // - d=2000 is the delay in ms in the callback + // - l=10000 is the length of the response + // + // time curl -N -v -G -d 'd=2000' -d 'l=10000' http://192.168.4.1/slow.html --output - + // + server.on("/slow.html", HTTP_GET, [](AsyncWebServerRequest *request) { + requests++; + uint32_t d = request->getParam("d")->value().toInt(); + uint32_t l = request->getParam("l")->value().toInt(); + Serial.printf("d = %" PRIu32 ", l = %" PRIu32 "\n", d, l); + AsyncWebServerResponse *response = request->beginChunkedResponse("text/html", [d, l](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { + Serial.printf("%u\n", index); + // finished ? + if (index >= l) { + return 0; + } + + // slow down the task to simulate some heavy processing, like SD card reading + delay(d); + + memset(buffer, characters[charactersIndex], 256); + charactersIndex = (charactersIndex + 1) % sizeof(characters); + return 256; + }); + + request->send(response); + }); + + // SSS endpoint + // + // launch 16 concurrent workers for 30 seconds + // > for i in {1..10}; do ( count=$(gtimeout 30 curl -s -N -H "Accept: text/event-stream" http://192.168.4.1/events 2>&1 | grep -c "^data:"); echo "Total: $count events, $(echo "$count / 4" | bc -l) events / second" ) & done; + // > for i in {1..16}; do ( count=$(gtimeout 30 curl -s -N -H "Accept: text/event-stream" http://192.168.4.1/events 2>&1 | grep -c "^data:"); echo "Total: $count events, $(echo "$count / 4" | bc -l) events / second" ) & done; + // + // With AsyncTCP, with 16 workers: a lot of "Event message queue overflow: discard message", no crash + // + // Total: 1711 events, 427.75 events / second + // Total: 1711 events, 427.75 events / second + // Total: 1626 events, 406.50 events / second + // Total: 1562 events, 390.50 events / second + // Total: 1706 events, 426.50 events / second + // Total: 1659 events, 414.75 events / second + // Total: 1624 events, 406.00 events / second + // Total: 1706 events, 426.50 events / second + // Total: 1487 events, 371.75 events / second + // Total: 1573 events, 393.25 events / second + // Total: 1569 events, 392.25 events / second + // Total: 1559 events, 389.75 events / second + // Total: 1560 events, 390.00 events / second + // Total: 1562 events, 390.50 events / second + // Total: 1626 events, 406.50 events / second + // + // With AsyncTCP, with 10 workers: + // + // Total: 2038 events, 509.50 events / second + // Total: 2120 events, 530.00 events / second + // Total: 2119 events, 529.75 events / second + // Total: 2038 events, 509.50 events / second + // Total: 2037 events, 509.25 events / second + // Total: 2119 events, 529.75 events / second + // Total: 2119 events, 529.75 events / second + // Total: 2120 events, 530.00 events / second + // Total: 2038 events, 509.50 events / second + // Total: 2038 events, 509.50 events / second + // + // With AsyncTCPSock, with 16 workers: ESP32 CRASH !!! + // + // With AsyncTCPSock, with 10 workers: + // + // Total: 1242 events, 310.50 events / second + // Total: 1242 events, 310.50 events / second + // Total: 1242 events, 310.50 events / second + // Total: 1242 events, 310.50 events / second + // Total: 1181 events, 295.25 events / second + // Total: 1182 events, 295.50 events / second + // Total: 1240 events, 310.00 events / second + // Total: 1181 events, 295.25 events / second + // Total: 1181 events, 295.25 events / second + // Total: 1183 events, 295.75 events / second + // + server.addHandler(&events); + + server.begin(); +} + +static uint32_t lastSSE = 0; +static uint32_t deltaSSE = 10; + +static uint32_t lastHeap = 0; + +void loop() { + uint32_t now = millis(); + if (now - lastSSE >= deltaSSE) { + events.send(String("ping-") + now, "heartbeat", now); + lastSSE = millis(); + } + +#ifdef ESP32 + if (now - lastHeap >= 2000) { + Serial.printf("Uptime: %3lu s, requests: %3u, Free heap: %" PRIu32 "\n", millis() / 1000, requests, ESP.getFreeHeap()); + lastHeap = now; + } +#endif +} diff --git a/examples/RateLimit/RateLimit.ino b/examples/RateLimit/RateLimit.ino new file mode 100644 index 0000000..89d6090 --- /dev/null +++ b/examples/RateLimit/RateLimit.ino @@ -0,0 +1,64 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Show how to rate limit the server or some endpoints +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); +static AsyncRateLimitMiddleware rateLimit; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // maximum 5 requests per 10 seconds + rateLimit.setMaxRequests(5); + rateLimit.setWindowSize(10); + + // run quickly several times: + // + // curl -v http://192.168.4.1/ + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + }); + + // run quickly several times: + // + // curl -v http://192.168.4.1/rate-limited + // + server + .on( + "/rate-limited", HTTP_GET, + [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + } + ) + .addMiddleware(&rateLimit); // only rate limit this endpoint, but could be applied globally to the server + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/Redirect/Redirect.ino b/examples/Redirect/Redirect.ino new file mode 100644 index 0000000..ce1b9fb --- /dev/null +++ b/examples/Redirect/Redirect.ino @@ -0,0 +1,48 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to redirect +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + request->redirect("/index.txt"); + }); + + // curl -v http://192.168.4.1/index.txt + server.on("/index.txt", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/RequestContinuation/RequestContinuation.ino b/examples/RequestContinuation/RequestContinuation.ino new file mode 100644 index 0000000..0584cf1 --- /dev/null +++ b/examples/RequestContinuation/RequestContinuation.ino @@ -0,0 +1,91 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to use request continuation to pause a request for a long processing task, and be able to resume it later. +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include +#include +#include + +static AsyncWebServer server(80); + +// request handler that is saved from the paused request to communicate with Serial +static String message; +static AsyncWebServerRequestPtr serialRequest; + +// request handler that is saved from the paused request to communicate with GPIO +static uint8_t pin = 35; +static AsyncWebServerRequestPtr gpioRequest; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // Post a message that will be sent to the Serial console, and pause the request until the user types a key + // + // curl -v -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "question=Name%3F%20" http://192.168.4.1/serial + // + // curl output should show "Answer: [y/n]" as the response + server.on("/serial", HTTP_POST, [](AsyncWebServerRequest *request) { + message = request->getParam("question", true)->value(); + serialRequest = request->pause(); + }); + + // Wait for a GPIO to be high + // + // curl -v http://192.168.4.1/gpio + // + // curl output should show "GPIO is high!" as the response + server.on("/gpio", HTTP_GET, [](AsyncWebServerRequest *request) { + gpioRequest = request->pause(); + }); + + pinMode(pin, INPUT); + + server.begin(); +} + +void loop() { + delay(500); + + // Check for a high voltage on the RX1 pin + if (digitalRead(pin) == HIGH) { + if (auto request = gpioRequest.lock()) { + request->send(200, "text/plain", "GPIO is high!"); + } + } + + // check for an incoming message from the Serial console + if (message.length()) { + Serial.printf("%s", message.c_str()); + // drops buffer + while (Serial.available()) { + Serial.read(); + } + Serial.setTimeout(10000); + String response = Serial.readStringUntil('\n'); // waits for a key to be pressed + Serial.println(); + message = emptyString; + if (auto request = serialRequest.lock()) { + request->send(200, "text/plain", "Answer: " + response); + } + } +} diff --git a/examples/RequestContinuationComplete/RequestContinuationComplete.ino b/examples/RequestContinuationComplete/RequestContinuationComplete.ino new file mode 100644 index 0000000..ccd16fd --- /dev/null +++ b/examples/RequestContinuationComplete/RequestContinuationComplete.ino @@ -0,0 +1,165 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to use request continuation to pause a request for a long processing task, and be able to resume it later. +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +#include +#include +#include + +static AsyncWebServer server(80); + +// =============================================================== +// The code below is used to simulate some long running operations +// =============================================================== + +typedef struct { + size_t id; + AsyncWebServerRequestPtr requestPtr; + uint8_t data; +} LongRunningOperation; + +static std::list> longRunningOperations; +static size_t longRunningOperationsCount = 0; +#ifdef ESP32 +static std::mutex longRunningOperationsMutex; +#endif + +static void startLongRunningOperation(AsyncWebServerRequestPtr &&requestPtr) { +#ifdef ESP32 + std::lock_guard lock(longRunningOperationsMutex); +#endif + + // LongRunningOperation *op = new LongRunningOperation(); + std::unique_ptr op(new LongRunningOperation()); + op->id = ++longRunningOperationsCount; + op->data = 10; + + // you need to hold the AsyncWebServerRequestPtr returned by pause(); + // This object is authorized to leave the scope of the request handler. + op->requestPtr = std::move(requestPtr); + + Serial.printf("[%u] Start long running operation for %" PRIu8 " seconds...\n", op->id, op->data); + longRunningOperations.push_back(std::move(op)); +} + +static bool processLongRunningOperation(LongRunningOperation *op) { + // request was deleted ? + if (op->requestPtr.expired()) { + Serial.printf("[%u] Request was deleted - stopping long running operation\n", op->id); + return true; // operation finished + } + + // processing the operation + Serial.printf("[%u] Long running operation processing... %" PRIu8 " seconds left\n", op->id, op->data); + + // check if we have finished ? + op->data--; + if (op->data) { + // not finished yet + return false; + } + + // Try to get access to the request pointer if it is still exist. + // If there has been a disconnection during that time, the pointer won't be valid anymore + if (auto request = op->requestPtr.lock()) { + Serial.printf("[%u] Long running operation finished! Sending back response...\n", op->id); + request->send(200, "text/plain", String(op->id) + " "); + + } else { + Serial.printf("[%u] Long running operation finished, but request was deleted!\n", op->id); + } + + return true; // operation finished +} + +/// ========================================================== + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // Add a middleware to see how pausing a request affects the middleware chain + server.addMiddleware([](AsyncWebServerRequest *request, ArMiddlewareNext next) { + Serial.printf("Middleware chain start\n"); + + // continue to the next middleware, and at the end the request handler + next(); + + // we can check the request pause state after the handler was executed + if (request->isPaused()) { + Serial.printf("Request was paused!\n"); + } + + Serial.printf("Middleware chain ends\n"); + }); + + // HOW TO RUN THIS EXAMPLE: + // + // 1. Open several terminals to trigger some requests concurrently that will be paused with: + // > time curl -v http://192.168.4.1/ + // + // 2. Look at the output of the Serial console to see how the middleware chain is executed + // and to see the long running operations being processed and resume the requests. + // + // 3. You can try close your curl command to cancel the request and check that the request is deleted. + // Note: in case the network is disconnected, the request will be deleted. + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // Print a message in case the request is disconnected (network disconnection, client close, etc.) + request->onDisconnect([]() { + Serial.printf("Request was disconnected!\n"); + }); + + // Instruct ESPAsyncWebServer to pause the request and get a AsyncWebServerRequestPtr to be able to access the request later. + // The AsyncWebServerRequestPtr is the ONLY object authorized to leave the scope of the request handler. + // The Middleware chain will continue to run until the end after this handler exit, but the request will be paused and will not + // be sent to the client until send() is called later. + Serial.printf("Pausing request...\n"); + AsyncWebServerRequestPtr requestPtr = request->pause(); + + // start our long operation... + startLongRunningOperation(std::move(requestPtr)); + }); + + server.begin(); +} + +static uint32_t lastTime = 0; + +void loop() { + if (millis() - lastTime >= 1000) { + +#ifdef ESP32 + Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); + std::lock_guard lock(longRunningOperationsMutex); +#endif + + // process all long running operations + longRunningOperations.remove_if([](const std::unique_ptr &op) { + return processLongRunningOperation(op.get()); + }); + + lastTime = millis(); + } +} diff --git a/examples/ResumableDownload/ResumableDownload.ino b/examples/ResumableDownload/ResumableDownload.ino new file mode 100644 index 0000000..373ca24 --- /dev/null +++ b/examples/ResumableDownload/ResumableDownload.ino @@ -0,0 +1,61 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Make sure resumable downloads can be implemented (HEAD request / response and Range header) +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + /* + ❯ curl -I -X HEAD http://192.168.4.1/download + HTTP/1.1 200 OK + Content-Length: 1024 + Content-Type: application/octet-stream + Connection: close + Accept-Ranges: bytes + */ + // Ref: https://github.com/mathieucarbou/ESPAsyncWebServer/pull/80 + server.on("/download", HTTP_HEAD | HTTP_GET, [](AsyncWebServerRequest *request) { + if (request->method() == HTTP_HEAD) { + AsyncWebServerResponse *response = request->beginResponse(200, "application/octet-stream"); + response->addHeader(asyncsrv::T_Accept_Ranges, "bytes"); + response->addHeader(asyncsrv::T_Content_Length, 10); + response->setContentLength(1024); // make sure we can overrides previously set content length + response->addHeader(asyncsrv::T_Content_Type, "foo"); + response->setContentType("application/octet-stream"); // make sure we can overrides previously set content type + // ... + request->send(response); + } else { + // ... + } + }); + + server.begin(); +} + +void loop() { + delay(100); +} diff --git a/examples/Rewrite/Rewrite.ino b/examples/Rewrite/Rewrite.ino new file mode 100644 index 0000000..6981b11 --- /dev/null +++ b/examples/Rewrite/Rewrite.ino @@ -0,0 +1,52 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to rewrite URLs +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/index.txt + server.on("/index.txt", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + }); + + // curl -v http://192.168.4.1/index.txt + server.on("/index.html", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/html", "

Hello, world!

"); + }); + + // curl -v http://192.168.4.1/ + server.rewrite("/", "/index.html"); + server.rewrite("/index.txt", "/index.html"); // will hide the .txt file + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/SSE_perftest/SSE_perftest.ino b/examples/SSE_perftest/SSE_perftest.ino deleted file mode 100644 index ecabd01..0000000 --- a/examples/SSE_perftest/SSE_perftest.ino +++ /dev/null @@ -1,257 +0,0 @@ -// -// SSE server with a load generator -// it will auto adjust message push rate to minimize discards across all connected clients -// per second stats is printed to a serial console and also published as SSE ping message -// open /sse URL to start events generator - -#include -#ifdef ESP32 - #include - #include -#elif defined(ESP8266) - #include - #include -#elif defined(TARGET_RP2040) - #include - #include -#endif - -#include - -#if __has_include("ArduinoJson.h") - #include - #include - #include -#endif - -#include - -const char* htmlContent PROGMEM = R"( - - - - Sample HTML - - -

Hello, World!

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

- - -)"; - -const char* staticContent PROGMEM = R"( - - - - Sample HTML - - -

Hello, %IP%

- - -)"; - -AsyncWebServer server(80); -AsyncEventSource events("/events"); - -///////////////////////////////////////////////////////////////////////////////////////////////////// - -const char* PARAM_MESSAGE PROGMEM = "message"; -const char* SSE_HTLM PROGMEM = R"( - - - - Server-Sent Events - - - -

Open your browser console!

- - -)"; - -static const char* SSE_MSG = R"(Alice felt that this could not be denied, so she tried another question. 'What sort of people live about here?' 'In THAT direction,' the Cat said, waving its right paw round, 'lives a Hatter: and in THAT direction,' waving the other paw, 'lives a March Hare. Visit either you like: they're both mad.' -'But I don't want to go among mad people,' Alice remarked. 'Oh, you can't help that,' said the Cat: 'we're all mad here. I'm mad. You're mad.' 'How do you know I'm mad?' said Alice. -'You must be,' said the Cat, `or you wouldn't have come here.' Alice didn't think that proved it at all; however, she went on 'And how do you know that you're mad?' 'To begin with,' said the Cat, 'a dog's not mad. You grant that?' -)"; - -void notFound(AsyncWebServerRequest* request) { - request->send(404, "text/plain", "Not found"); -} - -static const char characters[] = "0123456789ABCDEF"; -static size_t charactersIndex = 0; - -void setup() { - - Serial.begin(115200); - -#ifndef CONFIG_IDF_TARGET_ESP32H2 - /* - WiFi.mode(WIFI_STA); - WiFi.begin("SSID", "passwd"); - if (WiFi.waitForConnectResult() != WL_CONNECTED) { - Serial.printf("WiFi Failed!\n"); - return; - } - Serial.print("IP Address: "); - Serial.println(WiFi.localIP()); - */ - - WiFi.mode(WIFI_AP); - WiFi.softAP("esp-captive"); -#endif - - server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/html", staticContent); - }); - - events.onConnect([](AsyncEventSourceClient* client) { - if (client->lastId()) { - Serial.printf("SSE Client reconnected! Last message ID that it gat is: %" PRIu32 "\n", client->lastId()); - } - client->send("hello!", NULL, millis(), 1000); - }); - - server.on("/sse", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/html", SSE_HTLM); - }); - - // go to http://192.168.4.1/sse - server.addHandler(&events); - - server.onNotFound(notFound); - - server.begin(); -} - -uint32_t lastSSE = 0; -uint32_t deltaSSE = 25; -uint32_t messagesSSE = 4; // how many messages to q each time -uint32_t sse_disc{0}, sse_enq{0}, sse_penq{0}, sse_second{0}; - -AsyncEventSource::SendStatus enqueue() { - AsyncEventSource::SendStatus state = events.send(SSE_MSG, "message"); - if (state == AsyncEventSource::SendStatus::DISCARDED) - ++sse_disc; - else if (state == AsyncEventSource::SendStatus::ENQUEUED) { - ++sse_enq; - } else - ++sse_penq; - - return state; -} - -void loop() { - uint32_t now = millis(); - if (now - lastSSE >= deltaSSE) { - // enqueue messages - for (uint32_t i = 0; i != messagesSSE; ++i) { - auto err = enqueue(); - if (err == AsyncEventSource::SendStatus::DISCARDED || err == AsyncEventSource::SendStatus::PARTIALLY_ENQUEUED) { - // throttle messaging a bit - lastSSE = now + deltaSSE; - break; - } - } - - lastSSE = millis(); - } - - if (now - sse_second > 1000) { - String s; - s.reserve(100); - s = "Ping:"; - s += now / 1000; - s += " clients:"; - s += events.count(); - s += " disc:"; - s += sse_disc; - s += " enq:"; - s += sse_enq; - s += " partial:"; - s += sse_penq; - s += " avg wait:"; - s += events.avgPacketsWaiting(); - s += " heap:"; - s += ESP.getFreeHeap() / 1024; - - events.send(s, "heartbeat", now); - Serial.println(); - Serial.println(s); - - // if we see discards or partial enqueues, let's decrease message rate, else - increase. So that we can come to a max sustained message rate - if (sse_disc || sse_penq) - ++deltaSSE; - else if (deltaSSE > 5) - --deltaSSE; - - sse_disc = sse_enq = sse_penq = 0; - sse_second = now; - } -} diff --git a/examples/ServerSentEvents/ServerSentEvents.ino b/examples/ServerSentEvents/ServerSentEvents.ino new file mode 100644 index 0000000..91e2c1d --- /dev/null +++ b/examples/ServerSentEvents/ServerSentEvents.ino @@ -0,0 +1,105 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// SSE example +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static const char *htmlContent PROGMEM = R"( + + + + Server-Sent Events + + + +

Open your browser console!

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +static AsyncWebServer server(80); +static AsyncEventSource events("/events"); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + events.onConnect([](AsyncEventSourceClient *client) { + Serial.printf("SSE Client connected! ID: %" PRIu32 "\n", client->lastId()); + client->send("hello!", NULL, millis(), 1000); + }); + + events.onDisconnect([](AsyncEventSourceClient *client) { + Serial.printf("SSE Client disconnected! ID: %" PRIu32 "\n", client->lastId()); + }); + + server.addHandler(&events); + + server.begin(); +} + +static uint32_t lastSSE = 0; +static uint32_t deltaSSE = 3000; + +static uint32_t lastHeap = 0; + +void loop() { + uint32_t now = millis(); + if (now - lastSSE >= deltaSSE) { + events.send(String("ping-") + now, "heartbeat", now); + lastSSE = millis(); + } + +#ifdef ESP32 + if (now - lastHeap >= 2000) { + Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); + lastHeap = now; + } +#endif +} diff --git a/examples/SimpleServer/SimpleServer.ino b/examples/SimpleServer/SimpleServer.ino deleted file mode 100644 index 8a2ccfe..0000000 --- a/examples/SimpleServer/SimpleServer.ino +++ /dev/null @@ -1,794 +0,0 @@ -// -// A simple server implementation showing how to: -// * serve static messages -// * read GET and POST parameters -// * handle missing pages / 404s -// - -#include -#ifdef ESP32 - #include - #include -#elif defined(ESP8266) - #include - #include -#elif defined(TARGET_RP2040) - #include - #include -#endif - -#include - -#if __has_include("ArduinoJson.h") - #include - #include - #include -#endif - -#include - -const char* htmlContent PROGMEM = R"( - - - - Sample HTML - - -

Hello, World!

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

-

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod - rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper - arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit - accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. - Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo - dapibus elit, id varius sem dui id lacus.

- - -)"; - -const size_t htmlContentLength = strlen_P(htmlContent); - -const char* staticContent PROGMEM = R"( - - - - Sample HTML - - -

Hello, %IP%

- - -)"; - -AsyncWebServer server(80); -AsyncEventSource events("/events"); -AsyncWebSocket ws("/ws"); - -///////////////////////////////////////////////////////////////////////////////////////////////////// -// Middlewares -///////////////////////////////////////////////////////////////////////////////////////////////////// - -// log incoming requests -AsyncLoggingMiddleware requestLogger; - -// CORS -AsyncCorsMiddleware cors; - -// maximum 5 requests per 10 seconds -AsyncRateLimitMiddleware rateLimit; - -// filter out specific headers from the incoming request -AsyncHeaderFilterMiddleware headerFilter; - -// remove all headers from the incoming request except the ones provided in the constructor -AsyncHeaderFreeMiddleware headerFree; - -// basicAuth -AsyncAuthenticationMiddleware basicAuth; -AsyncAuthenticationMiddleware basicAuthHash; - -// simple digest authentication -AsyncAuthenticationMiddleware digestAuth; -AsyncAuthenticationMiddleware digestAuthHash; - -// complex authentication which adds request attributes for the next middlewares and handler -AsyncMiddlewareFunction complexAuth([](AsyncWebServerRequest* request, ArMiddlewareNext next) { - if (!request->authenticate("user", "password")) { - return request->requestAuthentication(); - } - request->setAttribute("user", "Mathieu"); - request->setAttribute("role", "staff"); - - next(); - - request->getResponse()->addHeader("X-Rate-Limit", "200"); -}); - -AsyncAuthorizationMiddleware authz([](AsyncWebServerRequest* request) { return request->getAttribute("role") == "staff"; }); - -int wsClients = 0; - -///////////////////////////////////////////////////////////////////////////////////////////////////// - -const char* PARAM_MESSAGE PROGMEM = "message"; -const char* SSE_HTLM PROGMEM = R"( - - - - Server-Sent Events - - - -

Open your browser console!

- - -)"; - -void notFound(AsyncWebServerRequest* request) { - request->send(404, "text/plain", "Not found"); -} - -#if __has_include("ArduinoJson.h") -AsyncCallbackJsonWebHandler* jsonHandler = new AsyncCallbackJsonWebHandler("/json2"); -AsyncCallbackMessagePackWebHandler* msgPackHandler = new AsyncCallbackMessagePackWebHandler("/msgpack2"); -#endif - -static const char characters[] = "0123456789ABCDEF"; -static size_t charactersIndex = 0; - -void setup() { - - Serial.begin(115200); - -#ifndef CONFIG_IDF_TARGET_ESP32H2 - // WiFi.mode(WIFI_STA); - // WiFi.begin("YOUR_SSID", "YOUR_PASSWORD"); - // if (WiFi.waitForConnectResult() != WL_CONNECTED) { - // Serial.printf("WiFi Failed!\n"); - // return; - // } - // Serial.print("IP Address: "); - // Serial.println(WiFi.localIP()); - - WiFi.mode(WIFI_AP); - WiFi.softAP("esp-captive"); -#endif - -#ifdef ESP32 - LittleFS.begin(true); -#else - LittleFS.begin(); -#endif - - { - File f = LittleFS.open("/index.txt", "w"); - if (f) { - for (size_t c = 0; c < sizeof(characters); c++) { - for (size_t i = 0; i < 1024; i++) { - f.print(characters[c]); - } - } - f.close(); - } - } - - { - File f = LittleFS.open("/index.html", "w"); - if (f) { - f.print(staticContent); - f.close(); - } - } - - // curl -v -X GET http://192.168.4.1/handler-not-sending-response - server.on("/handler-not-sending-response", HTTP_GET, [](AsyncWebServerRequest* request) { - // handler forgot to send a response to the client => 501 Not Implemented - }); - - // This is possible to replace a response. - // the previous one will be deleted. - // response sending happens when the handler returns. - // curl -v -X GET http://192.168.4.1/replace - server.on("/replace", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/plain", "Hello, world"); - // oups! finally we want to send a different response - request->send(400, "text/plain", "validation error"); -#ifndef TARGET_RP2040 - Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); -#endif - }); - - /////////////////////////////////////////////////////////////////////// - // Request header manipulations - /////////////////////////////////////////////////////////////////////// - - // curl -v -X GET -H "x-remove-me: value" http://192.168.4.1/headers - server.on("/headers", HTTP_GET, [](AsyncWebServerRequest* request) { - Serial.printf("Request Headers:\n"); - for (auto& h : request->getHeaders()) - Serial.printf("Request Header: %s = %s\n", h.name().c_str(), h.value().c_str()); - - // remove x-remove-me header - request->removeHeader("x-remove-me"); - Serial.printf("Request Headers:\n"); - for (auto& h : request->getHeaders()) - Serial.printf("Request Header: %s = %s\n", h.name().c_str(), h.value().c_str()); - - std::vector headers; - request->getHeaderNames(headers); - for (auto& h : headers) - Serial.printf("Request Header Name: %s\n", h); - - request->send(200); - }); - - /////////////////////////////////////////////////////////////////////// - // Middlewares at server level (will apply to all requests) - /////////////////////////////////////////////////////////////////////// - - requestLogger.setOutput(Serial); - - basicAuth.setUsername("admin"); - basicAuth.setPassword("admin"); - basicAuth.setRealm("MyApp"); - basicAuth.setAuthFailureMessage("Authentication failed"); - basicAuth.setAuthType(AsyncAuthType::AUTH_BASIC); - basicAuth.generateHash(); - - basicAuthHash.setUsername("admin"); - basicAuthHash.setPasswordHash("YWRtaW46YWRtaW4="); // BASE64(admin:admin) - basicAuthHash.setRealm("MyApp"); - basicAuthHash.setAuthFailureMessage("Authentication failed"); - basicAuthHash.setAuthType(AsyncAuthType::AUTH_BASIC); - - digestAuth.setUsername("admin"); - digestAuth.setPassword("admin"); - digestAuth.setRealm("MyApp"); - digestAuth.setAuthFailureMessage("Authentication failed"); - digestAuth.setAuthType(AsyncAuthType::AUTH_DIGEST); - digestAuth.generateHash(); - - digestAuthHash.setUsername("admin"); - digestAuthHash.setPasswordHash("f499b71f9a36d838b79268e145e132f7"); // MD5(user:realm:pass) - digestAuthHash.setRealm("MyApp"); - digestAuthHash.setAuthFailureMessage("Authentication failed"); - digestAuthHash.setAuthType(AsyncAuthType::AUTH_DIGEST); - - rateLimit.setMaxRequests(5); - rateLimit.setWindowSize(10); - - headerFilter.filter("X-Remove-Me"); - headerFree.keep("X-Keep-Me"); - headerFree.keep("host"); - - cors.setOrigin("http://192.168.4.1"); - cors.setMethods("POST, GET, OPTIONS, DELETE"); - cors.setHeaders("X-Custom-Header"); - cors.setAllowCredentials(false); - cors.setMaxAge(600); - -#ifndef PERF_TEST - // global middleware - server.addMiddleware(&requestLogger); - server.addMiddlewares({&rateLimit, &cors, &headerFilter}); -#endif - - // Test CORS preflight request - // curl -v -X OPTIONS -H "origin: http://192.168.4.1" http://192.168.4.1/middleware/cors - server.on("/middleware/cors", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/plain", "Hello, world!"); - }); - - // curl -v -X GET -H "x-remove-me: value" http://192.168.4.1/middleware/test-header-filter - // - requestLogger will log the incoming headers (including x-remove-me) - // - headerFilter will remove x-remove-me header - // - handler will log the remaining headers - server.on("/middleware/test-header-filter", HTTP_GET, [](AsyncWebServerRequest* request) { - for (auto& h : request->getHeaders()) - Serial.printf("Request Header: %s = %s\n", h.name().c_str(), h.value().c_str()); - request->send(200); - }); - - // curl -v -X GET -H "x-keep-me: value" http://192.168.4.1/middleware/test-header-free - // - requestLogger will log the incoming headers (including x-keep-me) - // - headerFree will remove all headers except x-keep-me and host - // - handler will log the remaining headers (x-keep-me and host) - server.on("/middleware/test-header-free", HTTP_GET, [](AsyncWebServerRequest* request) { - for (auto& h : request->getHeaders()) - Serial.printf("Request Header: %s = %s\n", h.name().c_str(), h.value().c_str()); - request->send(200); - }) - .addMiddleware(&headerFree); - - // basic authentication method - // curl -v -X GET -H "origin: http://192.168.4.1" -u admin:admin http://192.168.4.1/middleware/auth-basic - server.on("/middleware/auth-basic", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/plain", "Hello, world!"); - }) - .addMiddleware(&basicAuth); - - // basic authentication method with hash - // curl -v -X GET -H "origin: http://192.168.4.1" -u admin:admin http://192.168.4.1/middleware/auth-basic-hash - server.on("/middleware/auth-basic-hash", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/plain", "Hello, world!"); - }) - .addMiddleware(&basicAuthHash); - - // digest authentication - // curl -v -X GET -H "origin: http://192.168.4.1" -u admin:admin --digest http://192.168.4.1/middleware/auth-digest - server.on("/middleware/auth-digest", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/plain", "Hello, world!"); - }) - .addMiddleware(&digestAuth); - - // digest authentication with hash - // curl -v -X GET -H "origin: http://192.168.4.1" -u admin:admin --digest http://192.168.4.1/middleware/auth-digest-hash - server.on("/middleware/auth-digest-hash", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/plain", "Hello, world!"); - }) - .addMiddleware(&digestAuthHash); - - // test digest auth with cors - // curl -v -X GET -H "origin: http://192.168.4.1" --digest -u user:password http://192.168.4.1/middleware/auth-custom - server.on("/middleware/auth-custom", HTTP_GET, [](AsyncWebServerRequest* request) { - String buffer = "Hello "; - buffer.concat(request->getAttribute("user")); - buffer.concat(" with role: "); - buffer.concat(request->getAttribute("role")); - request->send(200, "text/plain", buffer); - }) - .addMiddlewares({&complexAuth, &authz}); - - /////////////////////////////////////////////////////////////////////// - - // curl -v -X GET -H "origin: http://192.168.4.1" http://192.168.4.1/redirect - // curl -v -X POST -H "origin: http://192.168.4.1" http://192.168.4.1/redirect - server.on("/redirect", HTTP_GET | HTTP_POST, [](AsyncWebServerRequest* request) { - request->redirect("/"); - }); - - // PERF TEST: - // > brew install autocannon - // > autocannon -c 10 -w 10 -d 20 http://192.168.4.1 - // > autocannon -c 16 -w 16 -d 20 http://192.168.4.1 - server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/html", htmlContent); - }); - - // curl -v -X GET http://192.168.4.1/index.txt - server.serveStatic("/index.txt", LittleFS, "/index.txt"); - - // curl -v -X GET http://192.168.4.1/index-private.txt - server.serveStatic("/index-private.txt", LittleFS, "/index.txt").setAuthentication("admin", "admin"); - - // ServeStatic static is used to serve static output which never changes over time. - // This special endpoints automatyically adds caching headers. - // If a template processor is used, it must enure that the outputed content will always be the ame over time and never changes. - // Otherwise, do not use serveStatic. - // Example below: IP never changes. - // curl -v -X GET http://192.168.4.1/index-static.html - server.serveStatic("/index-static.html", LittleFS, "/index.html").setTemplateProcessor([](const String& var) -> String { - if (var == "IP") { - // for CI, commented out since H2 board doesn ot support WiFi - // return WiFi.localIP().toString(); - // return WiFi.softAPIP().toString(); - return "127.0.0..1"; - } - return emptyString; - }); - - // to serve a template with dynamic content (output changes over time), use normal - // Example below: content changes over tinme do not use serveStatic. - // curl -v -X GET http://192.168.4.1/index-dynamic.html - server.on("/index-dynamic.html", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(LittleFS, "/index.html", "text/html", false, [](const String& var) -> String { - if (var == "IP") - return String(random(0, 1000)); - return emptyString; - }); - }); - - // Issue #14: assert failed: tcp_update_rcv_ann_wnd (needs help to test fix) - // > curl -v http://192.168.4.1/issue-14 - pinMode(4, OUTPUT); - server.on("/issue-14", HTTP_GET, [](AsyncWebServerRequest* request) { - digitalWrite(4, HIGH); - request->send(LittleFS, "/index.txt", "text/pain"); - delay(500); - digitalWrite(4, LOW); - }); - - /* - Chunked encoding test: sends 16k of characters. - ❯ curl -N -v -X GET -H "origin: http://192.168.4.1" http://192.168.4.1/chunk - */ - server.on("/chunk", HTTP_HEAD | HTTP_GET, [](AsyncWebServerRequest* request) { - AsyncWebServerResponse* response = request->beginChunkedResponse("text/html", [](uint8_t* buffer, size_t maxLen, size_t index) -> size_t { - if (index >= 16384) - return 0; - memset(buffer, characters[charactersIndex], maxLen); - charactersIndex = (charactersIndex + 1) % sizeof(characters); - return maxLen; - }); - request->send(response); - }); - - // curl -N -v -X GET http://192.168.4.1/chunked.html --output - - // curl -N -v -X GET -H "if-none-match: 4272" http://192.168.4.1/chunked.html --output - - server.on("/chunked.html", HTTP_GET, [](AsyncWebServerRequest* request) { - String len = String(htmlContentLength); - - if (request->header(asyncsrv::T_INM) == len) { - request->send(304); - return; - } - - AsyncWebServerResponse* response = request->beginChunkedResponse("text/html", [](uint8_t* buffer, size_t maxLen, size_t index) -> size_t { - Serial.printf("%u / %u\n", index, htmlContentLength); - - // finished ? - if (htmlContentLength <= index) { - Serial.println("finished"); - return 0; - } - - // serve a maximum of 1024 or maxLen bytes of the remaining content - const int chunkSize = min((size_t)1024, min(maxLen, htmlContentLength - index)); - Serial.printf("sending: %u\n", chunkSize); - - memcpy(buffer, htmlContent + index, chunkSize); - - return chunkSize; - }); - - response->addHeader(asyncsrv::T_Cache_Control, "public,max-age=60"); - response->addHeader(asyncsrv::T_ETag, len); - - request->send(response); - }); - - // time curl -N -v -G -d 'd=3000' -d 'l=10000' http://192.168.4.1/slow.html --output - - server.on("/slow.html", HTTP_GET, [](AsyncWebServerRequest* request) { - uint32_t d = request->getParam("d")->value().toInt(); - uint32_t l = request->getParam("l")->value().toInt(); - Serial.printf("d = %" PRIu32 ", l = %" PRIu32 "\n", d, l); - AsyncWebServerResponse* response = request->beginChunkedResponse("text/html", [d, l](uint8_t* buffer, size_t maxLen, size_t index) -> size_t { - Serial.printf("%u\n", index); - // finished ? - if (index >= l) - return 0; - - // slow down the task by 2 seconds - // to simulate some heavy processing, like SD card reading - delay(d); - - memset(buffer, characters[charactersIndex], 256); - charactersIndex = (charactersIndex + 1) % sizeof(characters); - return 256; - }); - - request->send(response); - }); - - /* - ❯ curl -I -X HEAD http://192.168.4.1/download - HTTP/1.1 200 OK - Content-Length: 1024 - Content-Type: application/octet-stream - Connection: close - Accept-Ranges: bytes - */ - // Ref: https://github.com/mathieucarbou/ESPAsyncWebServer/pull/80 - server.on("/download", HTTP_HEAD | HTTP_GET, [](AsyncWebServerRequest* request) { - if (request->method() == HTTP_HEAD) { - AsyncWebServerResponse* response = request->beginResponse(200, "application/octet-stream"); - response->addHeader(asyncsrv::T_Accept_Ranges, "bytes"); - response->addHeader(asyncsrv::T_Content_Length, 10); - response->setContentLength(1024); // overrides previous one - response->addHeader(asyncsrv::T_Content_Type, "foo"); - response->setContentType("application/octet-stream"); // overrides previous one - // ... - request->send(response); - } else { - // ... - } - }); - - // Send a GET request to /get?message= - server.on("/get", HTTP_GET, [](AsyncWebServerRequest* request) { - String message; - if (request->hasParam(PARAM_MESSAGE)) { - message = request->getParam(PARAM_MESSAGE)->value(); - } else { - message = "No message sent"; - } - request->send(200, "text/plain", "Hello, GET: " + message); - }); - - // Send a POST request to /post with a form field message set to - server.on("/post", HTTP_POST, [](AsyncWebServerRequest* request) { - String message; - if (request->hasParam(PARAM_MESSAGE, true)) { - message = request->getParam(PARAM_MESSAGE, true)->value(); - } else { - message = "No message sent"; - } - request->send(200, "text/plain", "Hello, POST: " + message); - }); - -#if __has_include("ArduinoJson.h") - // JSON - - // sends JSON - // curl -v -X GET http://192.168.4.1/json1 - server.on("/json1", HTTP_GET, [](AsyncWebServerRequest* request) { - AsyncJsonResponse* response = new AsyncJsonResponse(); - JsonObject root = response->getRoot().to(); - root["hello"] = "world"; - response->setLength(); - request->send(response); - }); - - // curl -v -X GET http://192.168.4.1/json2 - server.on("/json2", HTTP_GET, [](AsyncWebServerRequest* request) { - AsyncResponseStream* response = request->beginResponseStream("application/json"); - JsonDocument doc; - JsonObject root = doc.to(); - root["foo"] = "bar"; - serializeJson(root, *response); - request->send(response); - }); - - // curl -v -X POST -H 'Content-Type: application/json' -d '{"name":"You"}' http://192.168.4.1/json2 - // curl -v -X PUT -H 'Content-Type: application/json' -d '{"name":"You"}' http://192.168.4.1/json2 - jsonHandler->setMethod(HTTP_POST | HTTP_PUT); - jsonHandler->onRequest([](AsyncWebServerRequest* request, JsonVariant& json) { - serializeJson(json, Serial); - AsyncJsonResponse* response = new AsyncJsonResponse(); - JsonObject root = response->getRoot().to(); - root["hello"] = json.as()["name"]; - response->setLength(); - request->send(response); - }); - - // MessagePack - - // receives MessagePack and sends MessagePack - msgPackHandler->onRequest([](AsyncWebServerRequest* request, JsonVariant& json) { - // JsonObject jsonObj = json.as(); - // ... - - AsyncMessagePackResponse* response = new AsyncMessagePackResponse(); - JsonObject root = response->getRoot().to(); - root["hello"] = "world"; - response->setLength(); - request->send(response); - }); - - // sends MessagePack - server.on("/msgpack1", HTTP_GET, [](AsyncWebServerRequest* request) { - AsyncMessagePackResponse* response = new AsyncMessagePackResponse(); - JsonObject root = response->getRoot().to(); - root["hello"] = "world"; - response->setLength(); - request->send(response); - }); -#endif - - events.onConnect([](AsyncEventSourceClient* client) { - if (client->lastId()) { - Serial.printf("SSE Client reconnected! Last message ID that it gat is: %" PRIu32 "\n", client->lastId()); - } - client->send("hello!", NULL, millis(), 1000); - }); - - server.on("/sse", HTTP_GET, [](AsyncWebServerRequest* request) { - request->send(200, "text/html", SSE_HTLM); - }); - - ws.onEvent([](AsyncWebSocket* server, AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len) { - (void)len; - if (type == WS_EVT_CONNECT) { - wsClients++; - ws.textAll("new client connected"); - Serial.println("ws connect"); - client->setCloseClientOnQueueFull(false); - client->ping(); - } else if (type == WS_EVT_DISCONNECT) { - wsClients--; - ws.textAll("client disconnected"); - Serial.println("ws disconnect"); - } else if (type == WS_EVT_ERROR) { - Serial.println("ws error"); - } else if (type == WS_EVT_PONG) { - Serial.println("ws pong"); - } else if (type == WS_EVT_DATA) { - AwsFrameInfo* info = (AwsFrameInfo*)arg; - String msg = ""; - if (info->final && info->index == 0 && info->len == len) { - if (info->opcode == WS_TEXT) { - data[len] = 0; - Serial.printf("ws text: %s\n", (char*)data); - } - } - } - }); - - // SSS endpoints - // sends a message every 10 ms - // - // go to http://192.168.4.1/sse - // > curl -v -N -H "Accept: text/event-stream" http://192.168.4.1/events - // - // some perf tests: - // launch 16 concurrent workers for 30 seconds - // > for i in {1..10}; do ( count=$(gtimeout 30 curl -s -N -H "Accept: text/event-stream" http://192.168.4.1/events 2>&1 | grep -c "^data:"); echo "Total: $count events, $(echo "$count / 4" | bc -l) events / second" ) & done; - // > for i in {1..16}; do ( count=$(gtimeout 30 curl -s -N -H "Accept: text/event-stream" http://192.168.4.1/events 2>&1 | grep -c "^data:"); echo "Total: $count events, $(echo "$count / 4" | bc -l) events / second" ) & done; - // - // With AsyncTCP, with 16 workers: a lot of "Event message queue overflow: discard message", no crash - // - // Total: 1711 events, 427.75 events / second - // Total: 1711 events, 427.75 events / second - // Total: 1626 events, 406.50 events / second - // Total: 1562 events, 390.50 events / second - // Total: 1706 events, 426.50 events / second - // Total: 1659 events, 414.75 events / second - // Total: 1624 events, 406.00 events / second - // Total: 1706 events, 426.50 events / second - // Total: 1487 events, 371.75 events / second - // Total: 1573 events, 393.25 events / second - // Total: 1569 events, 392.25 events / second - // Total: 1559 events, 389.75 events / second - // Total: 1560 events, 390.00 events / second - // Total: 1562 events, 390.50 events / second - // Total: 1626 events, 406.50 events / second - // - // With AsyncTCP, with 10 workers: - // - // Total: 2038 events, 509.50 events / second - // Total: 2120 events, 530.00 events / second - // Total: 2119 events, 529.75 events / second - // Total: 2038 events, 509.50 events / second - // Total: 2037 events, 509.25 events / second - // Total: 2119 events, 529.75 events / second - // Total: 2119 events, 529.75 events / second - // Total: 2120 events, 530.00 events / second - // Total: 2038 events, 509.50 events / second - // Total: 2038 events, 509.50 events / second - // - // With AsyncTCPSock, with 16 workers: ESP32 CRASH !!! - // - // With AsyncTCPSock, with 10 workers: - // - // Total: 1242 events, 310.50 events / second - // Total: 1242 events, 310.50 events / second - // Total: 1242 events, 310.50 events / second - // Total: 1242 events, 310.50 events / second - // Total: 1181 events, 295.25 events / second - // Total: 1182 events, 295.50 events / second - // Total: 1240 events, 310.00 events / second - // Total: 1181 events, 295.25 events / second - // Total: 1181 events, 295.25 events / second - // Total: 1183 events, 295.75 events / second - // - server.addHandler(&events); - - // Run in terminal 1: websocat ws://192.168.4.1/ws => stream data - // Run in terminal 2: websocat ws://192.168.4.1/ws => stream data - // Run in terminal 3: websocat ws://192.168.4.1/ws => should fail: - /* -❯ websocat ws://192.168.4.1/ws -websocat: WebSocketError: WebSocketError: Received unexpected status code (503 Service Unavailable) -websocat: error running - */ - server.addHandler(&ws).addMiddleware([](AsyncWebServerRequest* request, ArMiddlewareNext next) { - if (ws.count() > 2) { - // too many clients - answer back immediately and stop processing next middlewares and handler - request->send(503, "text/plain", "Server is busy"); - } else { - // process next middleware and at the end the handler - next(); - } - }); - - // Reset connection on HTTP request: - // for i in {1..20}; do curl -v -X GET https://192.168.4.1:80; done; - // The heap size should not decrease over time. - -#if __has_include("ArduinoJson.h") - server.addHandler(jsonHandler); - server.addHandler(msgPackHandler); -#endif - - server.onNotFound(notFound); - - server.begin(); -} - -uint32_t lastSSE = 0; -uint32_t deltaSSE = 10; - -uint32_t lastWS = 0; -uint32_t deltaWS = 100; - -uint32_t lastHeap = 0; - -void loop() { - uint32_t now = millis(); - if (now - lastSSE >= deltaSSE) { - events.send(String("ping-") + now, "heartbeat", now); - lastSSE = millis(); - } - if (now - lastWS >= deltaWS) { - ws.printfAll("kp%.4f", (10.0 / 3.0)); - // for (auto& client : ws.getClients()) { - // client.printf("kp%.4f", (10.0 / 3.0)); - // } - lastWS = millis(); - } -#ifdef ESP32 - if (now - lastHeap >= 2000) { - Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); - lastHeap = now; - } -#endif -} diff --git a/examples/SkipServerMiddleware/SkipServerMiddleware.ino b/examples/SkipServerMiddleware/SkipServerMiddleware.ino new file mode 100644 index 0000000..d232c71 --- /dev/null +++ b/examples/SkipServerMiddleware/SkipServerMiddleware.ino @@ -0,0 +1,73 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Authentication and authorization middlewares +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +static AsyncAuthenticationMiddleware basicAuth; +static AsyncLoggingMiddleware logging; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // basic authentication + basicAuth.setUsername("admin"); + basicAuth.setPassword("admin"); + basicAuth.setRealm("MyApp"); + basicAuth.setAuthFailureMessage("Authentication failed"); + basicAuth.setAuthType(AsyncAuthType::AUTH_BASIC); + basicAuth.generateHash(); // precompute hash (optional but recommended) + + // logging middleware + logging.setEnabled(true); + logging.setOutput(Serial); + + // we apply auth middleware to the server globally + server.addMiddleware(&basicAuth); + + // protected endpoint: requires basic authentication + // curl -v -u admin:admin http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(200, "text/plain", "Hello, world!"); + }); + + // we skip all global middleware from the catchall handler + server.catchAllHandler().skipServerMiddlewares(); + // we apply a specific middleware to the catchall handler only to log requests without a handler defined + server.catchAllHandler().addMiddleware(&logging); + + // standard 404 handler: will display the request in the console i na curl-like style + // curl -v -H "Foo: Bar" http://192.168.4.1/foo + server.onNotFound([](AsyncWebServerRequest *request) { + request->send(404, "text/plain", "Not found"); + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/SlowChunkResponse/SlowChunkResponse.ino b/examples/SlowChunkResponse/SlowChunkResponse.ino new file mode 100644 index 0000000..bbf70b6 --- /dev/null +++ b/examples/SlowChunkResponse/SlowChunkResponse.ino @@ -0,0 +1,152 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Simulate a slow response in a chunk response (like file download from SD Card) +// poll events will be throttled. +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); +static constexpr char characters[] = "0123456789ABCDEF"; +static size_t charactersIndex = 0; + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + // IMPORTANT - DO NOT WRITE SUCH CODE IN PRODUCTON ! + // + // This example simulates the slowdown that can happen when: + // - downloading a huge file from sdcard + // - doing some file listing on SDCard because it is horribly slow to get a file listing with file stats on SDCard. + // So in both cases, ESP would deadlock or TWDT would trigger. + // + // This example simulats that by slowing down the chunk callback: + // - d=2000 is the delay in ms in the callback + // - l=10000 is the length of the response + // + // time curl -N -v -G -d 'd=2000' -d 'l=10000' http://192.168.4.1/slow.html --output - + // + server.on("/slow.html", HTTP_GET, [](AsyncWebServerRequest *request) { + uint32_t d = request->getParam("d")->value().toInt(); + uint32_t l = request->getParam("l")->value().toInt(); + Serial.printf("d = %" PRIu32 ", l = %" PRIu32 "\n", d, l); + AsyncWebServerResponse *response = request->beginChunkedResponse("text/html", [d, l](uint8_t *buffer, size_t maxLen, size_t index) -> size_t { + Serial.printf("%u\n", index); + // finished ? + if (index >= l) { + return 0; + } + + // slow down the task to simulate some heavy processing, like SD card reading + delay(d); + + memset(buffer, characters[charactersIndex], 256); + charactersIndex = (charactersIndex + 1) % sizeof(characters); + return 256; + }); + + request->send(response); + }); + + server.begin(); +} + +static uint32_t lastHeap = 0; + +void loop() { +#ifdef ESP32 + uint32_t now = millis(); + if (now - lastHeap >= 2000) { + Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); + lastHeap = now; + } +#endif +} diff --git a/examples/StaticFile/StaticFile.ino b/examples/StaticFile/StaticFile.ino new file mode 100644 index 0000000..3cdf188 --- /dev/null +++ b/examples/StaticFile/StaticFile.ino @@ -0,0 +1,122 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to serve a static file +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + +#ifdef ESP32 + LittleFS.begin(true); +#else + LittleFS.begin(); +#endif + + { + File f = LittleFS.open("/index.html", "w"); + assert(f); + f.print(htmlContent); + f.close(); + } + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + request->redirect("/index.html"); + }); + + // curl -v http://192.168.4.1/index.html + server.serveStatic("/index.html", LittleFS, "/index.html"); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/StreamFiles/StreamConcat.h b/examples/StreamFiles/StreamConcat.h deleted file mode 100644 index c1e1927..0000000 --- a/examples/StreamFiles/StreamConcat.h +++ /dev/null @@ -1,37 +0,0 @@ -#pragma once - -#include - -class StreamConcat : public Stream { - public: - StreamConcat(Stream* s1, Stream* s2) : _s1(s1), _s2(s2) {} - - size_t write(__unused const uint8_t* p, __unused size_t n) override { return 0; } - size_t write(__unused uint8_t c) override { return 0; } - void flush() override {} - - int available() override { return _s1->available() + _s2->available(); } - - int read() override { - int c = _s1->read(); - return c != -1 ? c : _s2->read(); - } - -#if defined(TARGET_RP2040) - size_t readBytes(char* buffer, size_t length) { -#else - size_t readBytes(char* buffer, size_t length) override { -#endif - size_t count = _s1->readBytes(buffer, length); - return count > 0 ? count : _s2->readBytes(buffer, length); - } - - int peek() override { - int c = _s1->peek(); - return c != -1 ? c : _s2->peek(); - } - - private: - Stream* _s1; - Stream* _s2; -}; diff --git a/examples/StreamFiles/StreamFiles.ino b/examples/StreamFiles/StreamFiles.ino deleted file mode 100644 index a0d6b9f..0000000 --- a/examples/StreamFiles/StreamFiles.ino +++ /dev/null @@ -1,89 +0,0 @@ -#include -#include -#ifdef ESP32 - #include - #include -#elif defined(ESP8266) - #include - #include -#elif defined(TARGET_RP2040) - #include - #include -#endif - -#include -#include -#include - -#include "StreamConcat.h" - -DNSServer dnsServer; -AsyncWebServer server(80); - -void setup() { - Serial.begin(115200); - - LittleFS.begin(); - -#ifndef CONFIG_IDF_TARGET_ESP32H2 - WiFi.mode(WIFI_AP); - WiFi.softAP("esp-captive"); - - dnsServer.start(53, "*", WiFi.softAPIP()); -#endif - - File file1 = LittleFS.open("/header.html", "w"); - file1.print("ESP Captive Portal"); - file1.close(); - - File file2 = LittleFS.open("/body.html", "w"); - file2.print("

Welcome to ESP Captive Portal

"); - file2.close(); - - File file3 = LittleFS.open("/footer.html", "w"); - file3.print(""); - file3.close(); - - server.on("/", HTTP_GET, [](AsyncWebServerRequest* request) { - File header = LittleFS.open("/header.html", "r"); - File body = LittleFS.open("/body.html", "r"); - StreamConcat stream1(&header, &body); - - StreamString content; -#if defined(TARGET_RP2040) - content.printf("FreeHeap: %d", rp2040.getFreeHeap()); -#else - content.printf("FreeHeap: %" PRIu32, ESP.getFreeHeap()); -#endif - StreamConcat stream2 = StreamConcat(&stream1, &content); - - File footer = LittleFS.open("/footer.html", "r"); - StreamConcat stream3 = StreamConcat(&stream2, &footer); - - request->send(stream3, "text/html", stream3.available()); - header.close(); - body.close(); - footer.close(); - }); - - server.onNotFound([](AsyncWebServerRequest* request) { - request->send(404, "text/plain", "Not found"); - }); - - server.begin(); -} - -uint32_t last = 0; - -void loop() { - // dnsServer.processNextRequest(); - - if (millis() - last > 2000) { -#if defined(TARGET_RP2040) - Serial.printf("FreeHeap: %d", rp2040.getFreeHeap()); -#else - Serial.printf("FreeHeap: %" PRIu32, ESP.getFreeHeap()); -#endif - last = millis(); - } -} \ No newline at end of file diff --git a/examples/Templates/Templates.ino b/examples/Templates/Templates.ino new file mode 100644 index 0000000..edc02c2 --- /dev/null +++ b/examples/Templates/Templates.ino @@ -0,0 +1,99 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to serve a static and dynamic template +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + +

Hello, %USER%

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + +#ifdef ESP32 + LittleFS.begin(true); +#else + LittleFS.begin(); +#endif + + { + File f = LittleFS.open("/template.html", "w"); + assert(f); + f.print(htmlContent); + f.close(); + } + + // Serve the static template file + // + // curl -v http://192.168.4.1/template.html + server.serveStatic("/template.html", LittleFS, "/template.html"); + + // Serve the static template with a template processor + // + // ServeStatic static is used to serve static output which never changes over time. + // This special endpoints automatically adds caching headers. + // If a template processor is used, it must ensure that the outputted content will always be the same over time and never changes. + // Otherwise, do not use serveStatic. + // Example below: IP never changes. + // + // curl -v http://192.168.4.1/index.html + server.serveStatic("/index.html", LittleFS, "/template.html").setTemplateProcessor([](const String &var) -> String { + if (var == "USER") { + return "Bob"; + } + return emptyString; + }); + + // Serve a template with dynamic content + // + // to serve a template with dynamic content (output changes over time), use normal + // Example below: content changes over tinme do not use serveStatic. + // + // curl -v http://192.168.4.1/dynamic.html + server.on("/dynamic.html", HTTP_GET, [](AsyncWebServerRequest *request) { + request->send(LittleFS, "/template.html", "text/html", false, [](const String &var) -> String { + if (var == "USER") { + return String("Bob ") + millis(); + } + return emptyString; + }); + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/Upload/Upload.ino b/examples/Upload/Upload.ino new file mode 100644 index 0000000..ceac47d --- /dev/null +++ b/examples/Upload/Upload.ino @@ -0,0 +1,171 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Demo text, binary and file upload +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include +#include +#include + +static AsyncWebServer server(80); + +void setup() { + Serial.begin(115200); + + if (!LittleFS.begin()) { + LittleFS.format(); + LittleFS.begin(); + } + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // 1. Generate a Lorem_ipsum.txt file of about 20KB of text + // + // 3. Run: curl -v -F "data=@Lorem_ipsum.txt" http://192.168.4.1/upload/text + // + server.on( + "/upload/text", HTTP_POST, + [](AsyncWebServerRequest *request) { + if (!request->_tempObject) { + return request->send(400, "text/plain", "Nothing uploaded"); + } + StreamString *buffer = reinterpret_cast(request->_tempObject); + Serial.printf("Text uploaded:\n%s\n", buffer->c_str()); + delete buffer; + request->_tempObject = nullptr; + request->send(200, "text/plain", "OK"); + }, + [](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) { + Serial.printf("Upload[%s]: start=%u, len=%u, final=%d\n", filename.c_str(), index, len, final); + + if (!index) { + // first pass + StreamString *buffer = new StreamString(); + size_t size = std::max(4094l, request->header("Content-Length").toInt()); + Serial.printf("Allocating string buffer of %u bytes\n", size); + if (!buffer->reserve(size)) { + delete buffer; + request->abort(); + } + request->_tempObject = buffer; + } + + if (len) { + reinterpret_cast(request->_tempObject)->write(data, len); + } + } + ); + + // 1. Generate a Lorem_ipsum.txt file of about 20KB of text + // + // 3. Run: curl -v -F "data=@Lorem_ipsum.txt" http://192.168.4.1/upload/file + // + server.on( + "/upload/file", HTTP_POST, + [](AsyncWebServerRequest *request) { + if (request->getResponse()) { + // 400 File not available for writing + return; + } + + if (!LittleFS.exists("/my_file.txt")) { + return request->send(400, "text/plain", "Nothing uploaded"); + } + + // sends back the uploaded file + request->send(LittleFS, "/my_file.txt", "text/plain"); + }, + [](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) { + Serial.printf("Upload[%s]: start=%u, len=%u, final=%d\n", filename.c_str(), index, len, final); + + if (!index) { + request->_tempFile = LittleFS.open("/my_file.txt", "w"); + + if (!request->_tempFile) { + request->send(400, "text/plain", "File not available for writing"); + } + } + if (len) { + request->_tempFile.write(data, len); + } + if (final) { + request->_tempFile.close(); + } + } + ); + + // + // Upload a binary file: curl -v -F "data=@file.mp3" http://192.168.4.1/upload/binary + // + server.on( + "/upload/binary", HTTP_POST, + [](AsyncWebServerRequest *request) { + // response already set ? + if (request->getResponse()) { + // 400 No Content-Length + return; + } + + // nothing uploaded ? + if (!request->_tempObject) { + return request->send(400, "text/plain", "Nothing uploaded"); + } + + uint8_t *buffer = reinterpret_cast(request->_tempObject); + // process the buffer + + delete buffer; + request->_tempObject = nullptr; + + request->send(200, "text/plain", "OK"); + }, + [](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) { + Serial.printf("Upload[%s]: start=%u, len=%u, final=%d\n", filename.c_str(), index, len, final); + + // first pass ? + if (!index) { + size_t size = request->header("Content-Length").toInt(); + if (!size) { + request->send(400, "text/plain", "No Content-Length"); + } else { + Serial.printf("Allocating buffer of %u bytes\n", size); + uint8_t *buffer = new (std::nothrow) uint8_t[size]; + if (!buffer) { + // not enough memory + request->abort(); + } else { + request->_tempObject = buffer; + } + } + } + + if (len) { + memcpy(reinterpret_cast(request->_tempObject) + index, data, len); + } + } + ); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/examples/WebSocket/WebSocket.ino b/examples/WebSocket/WebSocket.ino new file mode 100644 index 0000000..9fb6ffd --- /dev/null +++ b/examples/WebSocket/WebSocket.ino @@ -0,0 +1,113 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// WebSocket example +// + +#include +#ifdef ESP32 +#include +#include +#elif defined(ESP8266) +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#endif + +#include + +static AsyncWebServer server(80); +static AsyncWebSocket ws("/ws"); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // + // Run in terminal 1: websocat ws://192.168.4.1/ws => should stream data + // Run in terminal 2: websocat ws://192.168.4.1/ws => should stream data + // Run in terminal 3: websocat ws://192.168.4.1/ws => should fail: + // + // To send a message to the WebSocket server: + // + // echo "Hello!" | websocat ws://192.168.4.1/ws + // + ws.onEvent([](AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len) { + (void)len; + + if (type == WS_EVT_CONNECT) { + ws.textAll("new client connected"); + Serial.println("ws connect"); + client->setCloseClientOnQueueFull(false); + client->ping(); + + } else if (type == WS_EVT_DISCONNECT) { + ws.textAll("client disconnected"); + Serial.println("ws disconnect"); + + } else if (type == WS_EVT_ERROR) { + Serial.println("ws error"); + + } else if (type == WS_EVT_PONG) { + Serial.println("ws pong"); + + } else if (type == WS_EVT_DATA) { + AwsFrameInfo *info = (AwsFrameInfo *)arg; + Serial.printf("index: %" PRIu64 ", len: %" PRIu64 ", final: %" PRIu8 ", opcode: %" PRIu8 "\n", info->index, info->len, info->final, info->opcode); + String msg = ""; + if (info->final && info->index == 0 && info->len == len) { + if (info->opcode == WS_TEXT) { + data[len] = 0; + Serial.printf("ws text: %s\n", (char *)data); + } + } + } + }); + + // shows how to prevent a third WS client to connect + server.addHandler(&ws).addMiddleware([](AsyncWebServerRequest *request, ArMiddlewareNext next) { + // ws.count() is the current count of WS clients: this one is trying to upgrade its HTTP connection + if (ws.count() > 1) { + // if we have 2 clients or more, prevent the next one to connect + request->send(503, "text/plain", "Server is busy"); + } else { + // process next middleware and at the end the handler + next(); + } + }); + + server.addHandler(&ws); + + server.begin(); +} + +static uint32_t lastWS = 0; +static uint32_t deltaWS = 100; + +static uint32_t lastHeap = 0; + +void loop() { + uint32_t now = millis(); + + if (now - lastWS >= deltaWS) { + ws.printfAll("kp%.4f", (10.0 / 3.0)); + lastWS = millis(); + } + + if (now - lastHeap >= 2000) { + // cleanup disconnected clients or too many clients + ws.cleanupClients(); + +#ifdef ESP32 + Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); +#endif + lastHeap = now; + } +} diff --git a/idf_component.yml b/idf_component.yml new file mode 100644 index 0000000..905a36a --- /dev/null +++ b/idf_component.yml @@ -0,0 +1,37 @@ +description: "Async Web Server for ESP32 Arduino" +url: "https://github.com/ESP32Async/ESPAsyncWebServer" +license: "LGPL-3.0-or-later" +tags: + - arduino +files: + exclude: + - "idf_component_examples/" + - "idf_component_examples/**/*" + - "docs/" + - "docs/*" + - "examples/" + - "examples/**/*" + - ".gitignore" + - ".clang-format" + - ".gitpod.Dockerfile" + - ".gitpod.yml" + - ".codespellrc" + - ".editorconfig" + - ".pre-commit-config.yaml" + - "CODE_OF_CONDUCT.md" + - "library.json" + - "library.properties" + - "partitions-4MB.csv" + - "platformio.ini" + - "pre-commit.requirements.txt" +dependencies: + esp32async/asynctcp: + version: "^3.3.6" + require: public + bblanchon/arduinojson: + version: "^7.3.1" + require: public +examples: + - path: ./idf_component_examples/catchall + - path: ./idf_component_examples/serversentevents + - path: ./idf_component_examples/websocket diff --git a/idf_component_examples/catchall/CMakeLists.txt b/idf_component_examples/catchall/CMakeLists.txt new file mode 100644 index 0000000..664d458 --- /dev/null +++ b/idf_component_examples/catchall/CMakeLists.txt @@ -0,0 +1,8 @@ +# For more information about build system see +# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html +# The following five lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.16) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(main) diff --git a/idf_component_examples/catchall/README.md b/idf_component_examples/catchall/README.md new file mode 100644 index 0000000..1e09f91 --- /dev/null +++ b/idf_component_examples/catchall/README.md @@ -0,0 +1 @@ +### Basic example to show how to catch all requests and send a 404 Not Found response diff --git a/idf_component_examples/catchall/main/CMakeLists.txt b/idf_component_examples/catchall/main/CMakeLists.txt new file mode 100644 index 0000000..9eb7ec4 --- /dev/null +++ b/idf_component_examples/catchall/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "main.cpp" + INCLUDE_DIRS ".") diff --git a/idf_component_examples/catchall/main/idf_component.yml b/idf_component_examples/catchall/main/idf_component.yml new file mode 100644 index 0000000..e2d1c65 --- /dev/null +++ b/idf_component_examples/catchall/main/idf_component.yml @@ -0,0 +1,6 @@ +## IDF Component Manager Manifest File +dependencies: + esp32async/espasyncwebserver: + version: "*" + override_path: "../../../" + pre_release: true diff --git a/idf_component_examples/catchall/main/main.cpp b/idf_component_examples/catchall/main/main.cpp new file mode 100644 index 0000000..c491588 --- /dev/null +++ b/idf_component_examples/catchall/main/main.cpp @@ -0,0 +1,125 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// Shows how to catch all requests and send a 404 Not Found response +// + +#include +#include +#include + +#include + +static AsyncWebServer server(80); + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + // catch any request, and send a 404 Not Found response + // except for /game_log which is handled by onRequestBody + // + // curl -v http://192.168.4.1/foo + // + server.onNotFound([](AsyncWebServerRequest *request) { + if (request->url() == "/game_log") { + return; // response object already created by onRequestBody + } + + request->send(404, "text/plain", "Not found"); + }); + + // See: https://github.com/ESP32Async/ESPAsyncWebServer/issues/6 + // catch any POST request and send a 200 OK response + // + // curl -v -X POST http://192.168.4.1/game_log -H "Content-Type: application/json" -d '{"game": "test"}' + // + server.onRequestBody([](AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) { + if (request->url() == "/game_log") { + request->send(200, "application/json", "{\"status\":\"OK\"}"); + } + // note that there is no else here: the goal is only to prepare a response based on some body content + // onNotFound will always be called after this, and will not override the response object if `/game_log` is requested + }); + + server.begin(); +} + +// not needed +void loop() { + delay(100); +} diff --git a/idf_component_examples/catchall/sdkconfig.defaults b/idf_component_examples/catchall/sdkconfig.defaults new file mode 100644 index 0000000..bb72365 --- /dev/null +++ b/idf_component_examples/catchall/sdkconfig.defaults @@ -0,0 +1,12 @@ +# +# Arduino ESP32 +# +CONFIG_AUTOSTART_ARDUINO=y +# end of Arduino ESP32 + +# +# FREERTOS +# +CONFIG_FREERTOS_HZ=1000 +# end of FREERTOS +# end of Component config diff --git a/idf_component_examples/serversentevents/CMakeLists.txt b/idf_component_examples/serversentevents/CMakeLists.txt new file mode 100644 index 0000000..664d458 --- /dev/null +++ b/idf_component_examples/serversentevents/CMakeLists.txt @@ -0,0 +1,8 @@ +# For more information about build system see +# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html +# The following five lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.16) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(main) diff --git a/idf_component_examples/serversentevents/README.md b/idf_component_examples/serversentevents/README.md new file mode 100644 index 0000000..ea21ac9 --- /dev/null +++ b/idf_component_examples/serversentevents/README.md @@ -0,0 +1 @@ +### Basic example to show how to use ServerSentEvents diff --git a/idf_component_examples/serversentevents/main/CMakeLists.txt b/idf_component_examples/serversentevents/main/CMakeLists.txt new file mode 100644 index 0000000..9eb7ec4 --- /dev/null +++ b/idf_component_examples/serversentevents/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "main.cpp" + INCLUDE_DIRS ".") diff --git a/idf_component_examples/serversentevents/main/idf_component.yml b/idf_component_examples/serversentevents/main/idf_component.yml new file mode 100644 index 0000000..e2d1c65 --- /dev/null +++ b/idf_component_examples/serversentevents/main/idf_component.yml @@ -0,0 +1,6 @@ +## IDF Component Manager Manifest File +dependencies: + esp32async/espasyncwebserver: + version: "*" + override_path: "../../../" + pre_release: true diff --git a/idf_component_examples/serversentevents/main/main.cpp b/idf_component_examples/serversentevents/main/main.cpp new file mode 100644 index 0000000..59a1f59 --- /dev/null +++ b/idf_component_examples/serversentevents/main/main.cpp @@ -0,0 +1,95 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// SSE example +// + +#include +#include +#include + +#include + +static const char *htmlContent PROGMEM = R"( + + + + Server-Sent Events + + + +

Open your browser console!

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +static AsyncWebServer server(80); +static AsyncEventSource events("/events"); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // curl -v http://192.168.4.1/ + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + // need to cast to uint8_t* + // if you do not, the const char* will be copied in a temporary String buffer + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + events.onConnect([](AsyncEventSourceClient *client) { + Serial.printf("SSE Client connected! ID: %" PRIu32 "\n", client->lastId()); + client->send("hello!", NULL, millis(), 1000); + }); + + events.onDisconnect([](AsyncEventSourceClient *client) { + Serial.printf("SSE Client disconnected! ID: %" PRIu32 "\n", client->lastId()); + }); + + server.addHandler(&events); + + server.begin(); +} + +static uint32_t lastSSE = 0; +static uint32_t deltaSSE = 3000; + +static uint32_t lastHeap = 0; + +void loop() { + uint32_t now = millis(); + if (now - lastSSE >= deltaSSE) { + events.send(String("ping-") + now, "heartbeat", now); + lastSSE = millis(); + } + + if (now - lastHeap >= 2000) { + Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); + lastHeap = now; + } +} diff --git a/idf_component_examples/serversentevents/sdkconfig.defaults b/idf_component_examples/serversentevents/sdkconfig.defaults new file mode 100644 index 0000000..bb72365 --- /dev/null +++ b/idf_component_examples/serversentevents/sdkconfig.defaults @@ -0,0 +1,12 @@ +# +# Arduino ESP32 +# +CONFIG_AUTOSTART_ARDUINO=y +# end of Arduino ESP32 + +# +# FREERTOS +# +CONFIG_FREERTOS_HZ=1000 +# end of FREERTOS +# end of Component config diff --git a/idf_component_examples/websocket/CMakeLists.txt b/idf_component_examples/websocket/CMakeLists.txt new file mode 100644 index 0000000..664d458 --- /dev/null +++ b/idf_component_examples/websocket/CMakeLists.txt @@ -0,0 +1,8 @@ +# For more information about build system see +# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html +# The following five lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.16) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(main) diff --git a/idf_component_examples/websocket/README.md b/idf_component_examples/websocket/README.md new file mode 100644 index 0000000..3741fc3 --- /dev/null +++ b/idf_component_examples/websocket/README.md @@ -0,0 +1 @@ +### Basic example to show how to use WebSockets diff --git a/idf_component_examples/websocket/main/CMakeLists.txt b/idf_component_examples/websocket/main/CMakeLists.txt new file mode 100644 index 0000000..9eb7ec4 --- /dev/null +++ b/idf_component_examples/websocket/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "main.cpp" + INCLUDE_DIRS ".") diff --git a/idf_component_examples/websocket/main/idf_component.yml b/idf_component_examples/websocket/main/idf_component.yml new file mode 100644 index 0000000..e2d1c65 --- /dev/null +++ b/idf_component_examples/websocket/main/idf_component.yml @@ -0,0 +1,6 @@ +## IDF Component Manager Manifest File +dependencies: + esp32async/espasyncwebserver: + version: "*" + override_path: "../../../" + pre_release: true diff --git a/idf_component_examples/websocket/main/main.cpp b/idf_component_examples/websocket/main/main.cpp new file mode 100644 index 0000000..843d1a4 --- /dev/null +++ b/idf_component_examples/websocket/main/main.cpp @@ -0,0 +1,102 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// WebSocket example +// + +#include +#include +#include + +#include + +static AsyncWebServer server(80); +static AsyncWebSocket ws("/ws"); + +void setup() { + Serial.begin(115200); + +#ifndef CONFIG_IDF_TARGET_ESP32H2 + WiFi.mode(WIFI_AP); + WiFi.softAP("esp-captive"); +#endif + + // + // Run in terminal 1: websocat ws://192.168.4.1/ws => should stream data + // Run in terminal 2: websocat ws://192.168.4.1/ws => should stream data + // Run in terminal 3: websocat ws://192.168.4.1/ws => should fail: + // + // To send a message to the WebSocket server: + // + // echo "Hello!" | websocat ws://192.168.4.1/ws + // + ws.onEvent([](AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len) { + (void)len; + + if (type == WS_EVT_CONNECT) { + ws.textAll("new client connected"); + Serial.println("ws connect"); + client->setCloseClientOnQueueFull(false); + client->ping(); + + } else if (type == WS_EVT_DISCONNECT) { + ws.textAll("client disconnected"); + Serial.println("ws disconnect"); + + } else if (type == WS_EVT_ERROR) { + Serial.println("ws error"); + + } else if (type == WS_EVT_PONG) { + Serial.println("ws pong"); + + } else if (type == WS_EVT_DATA) { + AwsFrameInfo *info = (AwsFrameInfo *)arg; + String msg = ""; + if (info->final && info->index == 0 && info->len == len) { + if (info->opcode == WS_TEXT) { + data[len] = 0; + Serial.printf("ws text: %s\n", (char *)data); + } + } + } + }); + + // shows how to prevent a third WS client to connect + server.addHandler(&ws).addMiddleware([](AsyncWebServerRequest *request, ArMiddlewareNext next) { + // ws.count() is the current count of WS clients: this one is trying to upgrade its HTTP connection + if (ws.count() > 1) { + // if we have 2 clients or more, prevent the next one to connect + request->send(503, "text/plain", "Server is busy"); + } else { + // process next middleware and at the end the handler + next(); + } + }); + + server.addHandler(&ws); + + server.begin(); +} + +static uint32_t lastWS = 0; +static uint32_t deltaWS = 100; + +static uint32_t lastHeap = 0; + +void loop() { + uint32_t now = millis(); + + if (now - lastWS >= deltaWS) { + ws.printfAll("kp%.4f", (10.0 / 3.0)); + lastWS = millis(); + } + + if (now - lastHeap >= 2000) { + // cleanup disconnected clients or too many clients + ws.cleanupClients(); + + Serial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); + lastHeap = now; + } +} diff --git a/idf_component_examples/websocket/sdkconfig.defaults b/idf_component_examples/websocket/sdkconfig.defaults new file mode 100644 index 0000000..bb72365 --- /dev/null +++ b/idf_component_examples/websocket/sdkconfig.defaults @@ -0,0 +1,12 @@ +# +# Arduino ESP32 +# +CONFIG_AUTOSTART_ARDUINO=y +# end of Arduino ESP32 + +# +# FREERTOS +# +CONFIG_FREERTOS_HZ=1000 +# end of FREERTOS +# end of Component config diff --git a/library.json_ b/library.json similarity index 89% rename from library.json_ rename to library.json index 191a6e6..22cb862 100644 --- a/library.json_ +++ b/library.json @@ -1,6 +1,6 @@ { "name": "ESPAsyncWebServer", - "version": "3.6.0", + "version": "3.7.2", "description": "Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266 and RP2040. Supports: WebSocket, SSE, Authentication, Arduino Json 7, File Upload, Static File serving, URL Rewrite, URL Redirect, etc.", "keywords": "http,async,websocket,webserver", "homepage": "https://github.com/ESP32Async/ESPAsyncWebServer", @@ -24,7 +24,7 @@ { "owner": "ESP32Async", "name": "AsyncTCP", - "version": "^3.3.2", + "version": "^3.3.6", "platforms": "espressif32" }, { @@ -38,9 +38,9 @@ "platforms": "espressif8266" }, { - "owner": "khoih-prog", - "name": "AsyncTCP_RP2040W", - "version": "^1.2.0", + "owner": "ayushsharma82", + "name": "RPAsyncTCP", + "version": "^1.3.1", "platforms": "raspberrypi" } ], diff --git a/library.properties b/library.properties index d10f242..0f7229a 100644 --- a/library.properties +++ b/library.properties @@ -1,6 +1,6 @@ name=ESP Async WebServer includes=ESPAsyncWebServer.h -version=3.6.0 +version=3.7.2 author=ESP32Async maintainer=ESP32Async sentence=Asynchronous HTTP and WebSocket Server Library for ESP32, ESP8266 and RP2040 @@ -8,4 +8,4 @@ paragraph=Supports: WebSocket, SSE, Authentication, Arduino Json 7, File Upload, category=Other url=https://github.com/ESP32Async/ESPAsyncWebServer architectures=* -license=LGPL-3.0 \ No newline at end of file +license=LGPL-3.0 diff --git a/pioarduino_examples/IncreaseMaxSockets/.gitignore b/pioarduino_examples/IncreaseMaxSockets/.gitignore new file mode 100644 index 0000000..6c42fe0 --- /dev/null +++ b/pioarduino_examples/IncreaseMaxSockets/.gitignore @@ -0,0 +1,11 @@ +.DS_Store +.lh +/.pio +/.vscode +/logs + +/sdkconfig.* +/CMakeLists.txt +/dependencies.lock +/.dummy +/managed_components diff --git a/pioarduino_examples/IncreaseMaxSockets/platformio.ini b/pioarduino_examples/IncreaseMaxSockets/platformio.ini new file mode 100644 index 0000000..e132ec4 --- /dev/null +++ b/pioarduino_examples/IncreaseMaxSockets/platformio.ini @@ -0,0 +1,26 @@ +[env] +framework = arduino +platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.13/platform-espressif32.zip +build_flags = + -Og + -Wall -Wextra + -Wno-unused-parameter + -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_VERBOSE + ; -D CONFIG_ASYNC_TCP_MAX_ACK_TIME=5000 + ; -D CONFIG_ASYNC_TCP_PRIORITY=10 + -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128 + -D CONFIG_ASYNC_TCP_RUNNING_CORE=1 + -D CONFIG_ASYNC_TCP_STACK_SIZE=4096 +upload_protocol = esptool +monitor_speed = 115200 +monitor_filters = esp32_exception_decoder, log2file +lib_compat_mode = strict +lib_ldf_mode = chain +lib_deps = + ESP32Async/AsyncTCP @ 3.3.6 + ESP32Async/ESpAsyncWebServer @ 3.7.0 + +custom_sdkconfig = CONFIG_LWIP_MAX_ACTIVE_TCP=32 + +[env:esp32dev] +board = esp32dev diff --git a/pioarduino_examples/IncreaseMaxSockets/src/main.cpp b/pioarduino_examples/IncreaseMaxSockets/src/main.cpp new file mode 100644 index 0000000..752c402 --- /dev/null +++ b/pioarduino_examples/IncreaseMaxSockets/src/main.cpp @@ -0,0 +1,142 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +// +// This example demonstrates how to increase the maximum number of active TCP connections +// +// in platformo.ini: +// +// Use hybrid compilation to set the maximum number of active TCP connections +// +// custom_sdkconfig = CONFIG_LWIP_MAX_ACTIVE_TCP=32 +// +// and increase the queue stack size +// +// -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128 +// + +#include +#include +#include +#include + +static const char *htmlContent PROGMEM = R"( + + + + Sample HTML + + +

Hello, World!

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin euismod, purus a euismod + rhoncus, urna ipsum cursus massa, eu dictum tellus justo ac justo. Quisque ullamcorper + arcu nec tortor ullamcorper, vel fermentum justo fermentum. Vivamus sed velit ut elit + accumsan congue ut ut enim. Ut eu justo eu lacus varius gravida ut a tellus. Nulla facilisi. + Integer auctor consectetur ultricies. Fusce feugiat, mi sit amet bibendum viverra, orci leo + dapibus elit, id varius sem dui id lacus.

+ + +)"; + +static const size_t htmlContentLength = strlen_P(htmlContent); + +static AsyncWebServer server(80); +static AsyncEventSource events("/events"); + +static volatile size_t requests = 0; + +void setup() { + Serial.begin(115200); + + Serial.println("============================"); + Serial.printf("CONFIG_LWIP_MAX_ACTIVE_TCP %d\n", CONFIG_LWIP_MAX_ACTIVE_TCP); + Serial.println("============================"); + + WiFi.mode(WIFI_STA); + WiFi.begin("IoT", ""); + + while (WiFi.status() != WL_CONNECTED) { + delay(500); + Serial.println("Connecting to WiFi..."); + } + + // HTTP endpoint + // + // > autocannon -c 32 -d 20 -t 30 --renderStatusCodes http://192.168.125.146/ + // + server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { + requests++; + request->send(200, "text/html", (uint8_t *)htmlContent, htmlContentLength); + }); + + // SSS endpoint + // + // launch 32 concurrent workers for 30 seconds + // > for i in {1..32}; do ( count=$(gtimeout 30 curl -s -N -H "Accept: text/event-stream" http://192.168.125.146/events 2>&1 | grep -c "^data:"); echo "Total: $count events, $(echo "$count / 4" | bc -l) events / second" ) & done; + // + server.addHandler(&events); + + server.begin(); +} + +static uint32_t lastSSE = 0; +static uint32_t deltaSSE = 10; + +static uint32_t lastHeap = 0; + +void loop() { + uint32_t now = millis(); + if (now - lastSSE >= deltaSSE) { + events.send(String("ping-") + now, "heartbeat", now); + lastSSE = millis(); + } + +#ifdef ESP32 + if (now - lastHeap >= 2000) { + Serial.printf("Uptime: %3lu s, requests: %3u, Free heap: %" PRIu32 "\n", millis() / 1000, requests, ESP.getFreeHeap()); + lastHeap = now; + } +#endif +} diff --git a/platformio.ini b/platformio.ini index a731a50..2fa4f99 100644 --- a/platformio.ini +++ b/platformio.ini @@ -1,16 +1,42 @@ [platformio] -default_envs = arduino-2, arduino-3, arduino-311, esp8266, raspberrypi +default_envs = arduino-2, arduino-3, esp8266, raspberrypi lib_dir = . +; src_dir = examples/Auth ; src_dir = examples/CaptivePortal -src_dir = examples/SimpleServer -; src_dir = examples/StreamFiles +; src_dir = examples/CatchAllHandler +; src_dir = examples/ChunkResponse +; src_dir = examples/ChunkRetryResponse +; src_dir = examples/CORS +; src_dir = examples/EndBegin ; src_dir = examples/Filters -; src_dir = examples/Issue85 -; src_dir = examples/Issue162 +; src_dir = examples/FlashResponse +; src_dir = examples/HeaderManipulation +; src_dir = examples/Json +; src_dir = examples/Logging +; src_dir = examples/MessagePack +; src_dir = examples/Middleware +; src_dir = examples/Params +; src_dir = examples/PartitionDownloader +src_dir = examples/PerfTests +; src_dir = examples/RateLimit +; src_dir = examples/Redirect +; src_dir = examples/RequestContinuation +; src_dir = examples/RequestContinuationComplete +; src_dir = examples/ResumableDownload +; src_dir = examples/Rewrite +; src_dir = examples/ServerSentEvents +; src_dir = examples/SkipServerMiddleware +; src_dir = examples/SlowChunkResponse +; src_dir = examples/StaticFile +; src_dir = examples/Templates +; src_dir = examples/Upload +; src_dir = examples/WebSocket [env] framework = arduino -build_flags = +platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.13/platform-espressif32.zip +board = esp32dev +build_flags = -Og -Wall -Wextra -Wno-unused-parameter @@ -27,64 +53,53 @@ monitor_filters = esp32_exception_decoder, log2file ; monitor_filters = esp8266_exception_decoder, log2file lib_compat_mode = strict lib_ldf_mode = chain -lib_deps = - ; bblanchon/ArduinoJson @ 5.13.4 - ; bblanchon/ArduinoJson @ 6.21.5 - bblanchon/ArduinoJson @ 7.3.0 - ESP32Async/AsyncTCP @ 3.3.2 -board = esp32dev +lib_deps = + bblanchon/ArduinoJson @ 7.3.1 + ESP32Async/AsyncTCP @ 3.3.6 board_build.partitions = partitions-4MB.csv board_build.filesystem = littlefs [env:arduino-2] -platform = espressif32@6.9.0 +platform = espressif32@6.10.0 [env:arduino-3] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.05/platform-espressif32.zip -; board = esp32-s3-devkitc-1 -; board = esp32-c6-devkitc-1 + +[env:arduino-3-latest] +platform = https://github.com/pioarduino/platform-espressif32/releases/download/54.03.20-rc1/platform-espressif32.zip [env:arduino-3-no-json] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.05/platform-espressif32.zip -; board = esp32-s3-devkitc-1 -; board = esp32-c6-devkitc-1 -lib_deps = - ESP32Async/AsyncTCP @ 3.3.2 +lib_deps = + ESP32Async/AsyncTCP @ 3.3.6 -[env:arduino-311] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.11/platform-espressif32.zip -; board = esp32-s3-devkitc-1 -; board = esp32-c6-devkitc-1 -; board = esp32-h2-devkitm-1 +[env:arduino-3-latest-asynctcp] +lib_deps = + https://github.com/ESP32Async/AsyncTCP -[env:perf-test-AsyncTCP] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.11/platform-espressif32.zip +[env:arduino-3-no-chunk-inflight] build_flags = ${env.build_flags} - -D PERF_TEST=1 + -D ASYNCWEBSERVER_USE_CHUNK_INFLIGHT=0 -[env:perf-test-AsyncTCPSock] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.11/platform-espressif32.zip -lib_deps = +[env:AsyncTCPSock] +lib_deps = https://github.com/ESP32Async/AsyncTCPSock/archive/refs/tags/v1.0.3-dev.zip build_flags = ${env.build_flags} - -D PERF_TEST=1 [env:esp8266] platform = espressif8266 ; board = huzzah board = d1_mini -lib_deps = - bblanchon/ArduinoJson @ 7.3.0 +lib_deps = + bblanchon/ArduinoJson @ 7.3.1 ESP32Async/ESPAsyncTCP @ 2.0.0 [env:raspberrypi] -platform = https://github.com/maxgerhardt/platform-raspberrypi.git +platform = https://github.com/maxgerhardt/platform-raspberrypi.git#c7502925e3b08af70e9f924d54ab9d00a7e64781 board = rpipicow board_build.core = earlephilhower -lib_deps = +lib_deps = bblanchon/ArduinoJson @ 7.3.0 - khoih-prog/AsyncTCP_RP2040W @ 1.2.0 -lib_ignore = + ayushsharma82/RPAsyncTCP@^1.3.1 +lib_ignore = lwIP_ESPHost build_flags = ${env.build_flags} -Wno-missing-field-initializers @@ -92,38 +107,45 @@ build_flags = ${env.build_flags} ; CI [env:ci-arduino-2] -platform = espressif32@6.9.0 +platform = espressif32@6.10.0 board = ${sysenv.PIO_BOARD} [env:ci-arduino-3] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.05/platform-espressif32.zip +board = ${sysenv.PIO_BOARD} + +[env:ci-arduino-3-latest] +platform = https://github.com/pioarduino/platform-espressif32/releases/download/54.03.20-rc1/platform-espressif32.zip board = ${sysenv.PIO_BOARD} [env:ci-arduino-3-no-json] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/51.03.05/platform-espressif32.zip board = ${sysenv.PIO_BOARD} -lib_deps = - ESP32Async/AsyncTCP @ 3.3.2 +lib_deps = + ESP32Async/AsyncTCP @ 3.3.6 -[env:ci-arduino-311] -platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.11/platform-espressif32.zip +[env:ci-arduino-3-latest-asynctcp] +lib_deps = + https://github.com/ESP32Async/AsyncTCP + +[env:ci-arduino-3-no-chunk-inflight] board = ${sysenv.PIO_BOARD} +build_flags = ${env.build_flags} + -D ASYNCWEBSERVER_USE_CHUNK_INFLIGHT=1 [env:ci-esp8266] platform = espressif8266 board = ${sysenv.PIO_BOARD} -lib_deps = - bblanchon/ArduinoJson @ 7.3.0 +lib_deps = + bblanchon/ArduinoJson @ 7.3.1 ESP32Async/ESPAsyncTCP @ 2.0.0 [env:ci-raspberrypi] -platform = https://github.com/maxgerhardt/platform-raspberrypi.git +platform = https://github.com/maxgerhardt/platform-raspberrypi.git#c7502925e3b08af70e9f924d54ab9d00a7e64781 board = ${sysenv.PIO_BOARD} board_build.core = earlephilhower -lib_deps = +lib_deps = bblanchon/ArduinoJson @ 7.3.0 - khoih-prog/AsyncTCP_RP2040W @ 1.2.0 -lib_ignore = + ayushsharma82/RPAsyncTCP@^1.3.1 +lib_ignore = lwIP_ESPHost build_flags = ${env.build_flags} -Wno-missing-field-initializers diff --git a/pre-commit.requirements.txt b/pre-commit.requirements.txt new file mode 100644 index 0000000..40a16fa --- /dev/null +++ b/pre-commit.requirements.txt @@ -0,0 +1 @@ +pre-commit==4.1.0 diff --git a/src/AsyncEventSource.cpp b/src/AsyncEventSource.cpp index 874faa0..797c5d1 100644 --- a/src/AsyncEventSource.cpp +++ b/src/AsyncEventSource.cpp @@ -1,25 +1,9 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #include "Arduino.h" #if defined(ESP32) - #include +#include #endif #include "AsyncEventSource.h" @@ -27,46 +11,54 @@ using namespace asyncsrv; -static String generateEventMessage(const char* message, const char* event, uint32_t id, uint32_t reconnect) { +static String generateEventMessage(const char *message, const char *event, uint32_t id, uint32_t reconnect) { String str; size_t len{0}; - if (message) + if (message) { len += strlen(message); + } - if (event) + if (event) { len += strlen(event); + } - len += 42; // give it some overhead + len += 42; // give it some overhead - str.reserve(len); + if (!str.reserve(len)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + return emptyString; + } if (reconnect) { str += T_retry_; str += reconnect; - str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' + str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' } if (id) { str += T_id__; str += id; - str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' + str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' } if (event != NULL) { str += T_event_; str += event; - str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' + str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' } - if (!message) + if (!message) { return str; + } size_t messageLen = strlen(message); - char* lineStart = (char*)message; - char* lineEnd; + char *lineStart = (char *)message; + char *lineEnd; do { - char* nextN = strchr(lineStart, '\n'); - char* nextR = strchr(lineStart, '\r'); + char *nextN = strchr(lineStart, '\n'); + char *nextR = strchr(lineStart, '\r'); if (nextN == NULL && nextR == NULL) { // a message is a single-line string str += T_data_; @@ -76,10 +68,10 @@ static String generateEventMessage(const char* message, const char* event, uint3 } // a message is a multi-line string - char* nextLine = NULL; - if (nextN != NULL && nextR != NULL) { // windows line-ending \r\n + char *nextLine = NULL; + if (nextN != NULL && nextR != NULL) { // windows line-ending \r\n if (nextR + 1 == nextN) { - // normal \r\n sequense + // normal \r\n sequence lineEnd = nextR; nextLine = nextN + 1; } else { @@ -87,23 +79,23 @@ static String generateEventMessage(const char* message, const char* event, uint3 lineEnd = std::min(nextR, nextN); nextLine = lineEnd + 1; } - } else if (nextN != NULL) { // Unix/Mac OS X LF + } else if (nextN != NULL) { // Unix/Mac OS X LF lineEnd = nextN; nextLine = nextN + 1; - } else { // some ancient garbage + } else { // some ancient garbage lineEnd = nextR; nextLine = nextR + 1; } str += T_data_; str.concat(lineStart, lineEnd - lineStart); - str += ASYNC_SSE_NEW_LINE_CHAR; // \n + str += ASYNC_SSE_NEW_LINE_CHAR; // \n lineStart = nextLine; - } while (lineStart < ((char*)message + messageLen)); + } while (lineStart < ((char *)message + messageLen)); // append another \n to terminate message - str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' + str += ASYNC_SSE_NEW_LINE_CHAR; // '\n' return str; } @@ -123,9 +115,10 @@ size_t AsyncEventSourceMessage::ack(size_t len, __attribute__((unused)) uint32_t return 0; } -size_t AsyncEventSourceMessage::write(AsyncClient* client) { - if (!client) +size_t AsyncEventSourceMessage::write(AsyncClient *client) { + if (!client) { return 0; + } if (_sent >= _data->length() || !client->canSend()) { return 0; @@ -143,31 +136,54 @@ size_t AsyncEventSourceMessage::write(AsyncClient* client) { So let's just keep it enforced ASYNC_WRITE_FLAG_COPY and keep in mind that there is no zero-copy */ - size_t written = client->add(_data->c_str() + _sent, len, ASYNC_WRITE_FLAG_COPY); // ASYNC_WRITE_FLAG_MORE + size_t written = client->add(_data->c_str() + _sent, len, ASYNC_WRITE_FLAG_COPY); // ASYNC_WRITE_FLAG_MORE _sent += written; return written; } -size_t AsyncEventSourceMessage::send(AsyncClient* client) { +size_t AsyncEventSourceMessage::send(AsyncClient *client) { size_t sent = write(client); return sent && client->send() ? sent : 0; } // Client -AsyncEventSourceClient::AsyncEventSourceClient(AsyncWebServerRequest* request, AsyncEventSource* server) - : _client(request->client()), _server(server) { +AsyncEventSourceClient::AsyncEventSourceClient(AsyncWebServerRequest *request, AsyncEventSource *server) : _client(request->client()), _server(server) { - if (request->hasHeader(T_Last_Event_ID)) + if (request->hasHeader(T_Last_Event_ID)) { _lastId = atoi(request->getHeader(T_Last_Event_ID)->value().c_str()); + } _client->setRxTimeout(0); _client->onError(NULL, NULL); - _client->onAck([](void* r, AsyncClient* c, size_t len, uint32_t time) { (void)c; static_cast(r)->_onAck(len, time); }, this); - _client->onPoll([](void* r, AsyncClient* c) { (void)c; static_cast(r)->_onPoll(); }, this); + _client->onAck( + [](void *r, AsyncClient *c, size_t len, uint32_t time) { + (void)c; + static_cast(r)->_onAck(len, time); + }, + this + ); + _client->onPoll( + [](void *r, AsyncClient *c) { + (void)c; + static_cast(r)->_onPoll(); + }, + this + ); _client->onData(NULL, NULL); - _client->onTimeout([this](void* r, AsyncClient* c __attribute__((unused)), uint32_t time) { static_cast(r)->_onTimeout(time); }, this); - _client->onDisconnect([this](void* r, AsyncClient* c) { static_cast(r)->_onDisconnect(); delete c; }, this); + _client->onTimeout( + [this](void *r, AsyncClient *c __attribute__((unused)), uint32_t time) { + static_cast(r)->_onTimeout(time); + }, + this + ); + _client->onDisconnect( + [this](void *r, AsyncClient *c) { + static_cast(r)->_onDisconnect(); + delete c; + }, + this + ); _server->_addClient(this); delete request; @@ -183,7 +199,7 @@ AsyncEventSourceClient::~AsyncEventSourceClient() { close(); } -bool AsyncEventSourceClient::_queueMessage(const char* message, size_t len) { +bool AsyncEventSourceClient::_queueMessage(const char *message, size_t len) { if (_messageQueue.size() >= SSE_MAX_QUEUED_MESSAGES) { #ifdef ESP8266 ets_printf(String(F("ERROR: Too many messages queued\n")).c_str()); @@ -213,7 +229,7 @@ bool AsyncEventSourceClient::_queueMessage(const char* message, size_t len) { return true; } -bool AsyncEventSourceClient::_queueMessage(AsyncEvent_SharedData_t&& msg) { +bool AsyncEventSourceClient::_queueMessage(AsyncEvent_SharedData_t &&msg) { if (_messageQueue.size() >= SSE_MAX_QUEUED_MESSAGES) { #ifdef ESP8266 ets_printf(String(F("ERROR: Too many messages queued\n")).c_str()); @@ -249,10 +265,11 @@ void AsyncEventSourceClient::_onAck(size_t len __attribute__((unused)), uint32_t #endif // adjust in-flight len - if (len < _inflight) + if (len < _inflight) { _inflight -= len; - else + } else { _inflight = 0; + } // acknowledge as much messages's data as we got confirmed len from a AsyncTCP while (len && _messageQueue.size()) { @@ -264,8 +281,9 @@ void AsyncEventSourceClient::_onAck(size_t len __attribute__((unused)), uint32_t } // try to send another batch of data - if (_messageQueue.size()) + if (_messageQueue.size()) { _runQueue(); + } } void AsyncEventSourceClient::_onPoll() { @@ -279,31 +297,36 @@ void AsyncEventSourceClient::_onPoll() { } void AsyncEventSourceClient::_onTimeout(uint32_t time __attribute__((unused))) { - if (_client) + if (_client) { _client->close(true); + } } void AsyncEventSourceClient::_onDisconnect() { - if (!_client) + if (!_client) { return; + } _client = nullptr; _server->_handleDisconnect(this); } void AsyncEventSourceClient::close() { - if (_client) + if (_client) { _client->close(); + } } -bool AsyncEventSourceClient::send(const char* message, const char* event, uint32_t id, uint32_t reconnect) { - if (!connected()) +bool AsyncEventSourceClient::send(const char *message, const char *event, uint32_t id, uint32_t reconnect) { + if (!connected()) { return false; + } return _queueMessage(std::make_shared(generateEventMessage(message, event, id, reconnect))); } void AsyncEventSourceClient::_runQueue() { - if (!_client) + if (!_client) { return; + } // there is no need to lock the mutex here, 'cause all the calls to this method must be already lock'ed size_t total_bytes_written = 0; @@ -320,45 +343,52 @@ void AsyncEventSourceClient::_runQueue() { } // flush socket - if (total_bytes_written) + if (total_bytes_written) { _client->send(); + } } void AsyncEventSourceClient::set_max_inflight_bytes(size_t value) { - if (value >= SSE_MIN_INFLIGH && value <= SSE_MAX_INFLIGH) + if (value >= SSE_MIN_INFLIGH && value <= SSE_MAX_INFLIGH) { _max_inflight = value; + } } /* AsyncEventSource */ void AsyncEventSource::authorizeConnect(ArAuthorizeConnectHandler cb) { - AsyncAuthorizationMiddleware* m = new AsyncAuthorizationMiddleware(401, cb); + AsyncAuthorizationMiddleware *m = new AsyncAuthorizationMiddleware(401, cb); m->_freeOnRemoval = true; addMiddleware(m); } -void AsyncEventSource::_addClient(AsyncEventSourceClient* client) { - if (!client) +void AsyncEventSource::_addClient(AsyncEventSourceClient *client) { + if (!client) { return; + } #ifdef ESP32 std::lock_guard lock(_client_queue_lock); #endif _clients.emplace_back(client); - if (_connectcb) + if (_connectcb) { _connectcb(client); + } _adjust_inflight_window(); } -void AsyncEventSource::_handleDisconnect(AsyncEventSourceClient* client) { - if (_disconnectcb) +void AsyncEventSource::_handleDisconnect(AsyncEventSourceClient *client) { + if (_disconnectcb) { _disconnectcb(client); + } #ifdef ESP32 std::lock_guard lock(_client_queue_lock); #endif for (auto i = _clients.begin(); i != _clients.end(); ++i) { - if (i->get() == client) + if (i->get() == client) { _clients.erase(i); + break; + } } _adjust_inflight_window(); } @@ -370,9 +400,10 @@ void AsyncEventSource::close() { #ifdef ESP32 std::lock_guard lock(_client_queue_lock); #endif - for (const auto& c : _clients) { - if (c->connected()) + for (const auto &c : _clients) { + if (c->connected()) { c->close(); + } } } @@ -383,31 +414,32 @@ size_t AsyncEventSource::avgPacketsWaiting() const { #ifdef ESP32 std::lock_guard lock(_client_queue_lock); #endif - if (!_clients.size()) + if (!_clients.size()) { return 0; + } - for (const auto& c : _clients) { + for (const auto &c : _clients) { if (c->connected()) { aql += c->packetsWaiting(); ++nConnectedClients; } } - return ((aql) + (nConnectedClients / 2)) / (nConnectedClients); // round up + return ((aql) + (nConnectedClients / 2)) / (nConnectedClients); // round up } -AsyncEventSource::SendStatus AsyncEventSource::send( - const char* message, const char* event, uint32_t id, uint32_t reconnect) { +AsyncEventSource::SendStatus AsyncEventSource::send(const char *message, const char *event, uint32_t id, uint32_t reconnect) { AsyncEvent_SharedData_t shared_msg = std::make_shared(generateEventMessage(message, event, id, reconnect)); #ifdef ESP32 std::lock_guard lock(_client_queue_lock); #endif size_t hits = 0; size_t miss = 0; - for (const auto& c : _clients) { - if (c->write(shared_msg)) + for (const auto &c : _clients) { + if (c->write(shared_msg)) { ++hits; - else + } else { ++miss; + } } return hits == 0 ? DISCARDED : (miss == 0 ? ENQUEUED : PARTIALLY_ENQUEUED); } @@ -417,33 +449,36 @@ size_t AsyncEventSource::count() const { std::lock_guard lock(_client_queue_lock); #endif size_t n_clients{0}; - for (const auto& i : _clients) - if (i->connected()) + for (const auto &i : _clients) { + if (i->connected()) { ++n_clients; + } + } return n_clients; } -bool AsyncEventSource::canHandle(AsyncWebServerRequest* request) const { +bool AsyncEventSource::canHandle(AsyncWebServerRequest *request) const { return request->isSSE() && request->url().equals(_url); } -void AsyncEventSource::handleRequest(AsyncWebServerRequest* request) { +void AsyncEventSource::handleRequest(AsyncWebServerRequest *request) { request->send(new AsyncEventSourceResponse(this)); } void AsyncEventSource::_adjust_inflight_window() { if (_clients.size()) { size_t inflight = SSE_MAX_INFLIGH / _clients.size(); - for (const auto& c : _clients) + for (const auto &c : _clients) { c->set_max_inflight_bytes(inflight); + } // Serial.printf("adjusted inflight to: %u\n", inflight); } } /* Response */ -AsyncEventSourceResponse::AsyncEventSourceResponse(AsyncEventSource* server) { +AsyncEventSourceResponse::AsyncEventSourceResponse(AsyncEventSource *server) { _server = server; _code = 200; _contentType = T_text_event_stream; @@ -452,14 +487,14 @@ AsyncEventSourceResponse::AsyncEventSourceResponse(AsyncEventSource* server) { addHeader(T_Connection, T_keep_alive); } -void AsyncEventSourceResponse::_respond(AsyncWebServerRequest* request) { +void AsyncEventSourceResponse::_respond(AsyncWebServerRequest *request) { String out; _assembleHead(out, request->version()); request->client()->write(out.c_str(), _headLength); _state = RESPONSE_WAIT_ACK; } -size_t AsyncEventSourceResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time __attribute__((unused))) { +size_t AsyncEventSourceResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time __attribute__((unused))) { if (len) { new AsyncEventSourceClient(request, _server); } diff --git a/src/AsyncEventSource.h b/src/AsyncEventSource.h index 0796fae..fe4c840 100644 --- a/src/AsyncEventSource.h +++ b/src/AsyncEventSource.h @@ -1,64 +1,48 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #ifndef ASYNCEVENTSOURCE_H_ #define ASYNCEVENTSOURCE_H_ #include #ifdef ESP32 - #include - #include - #ifndef SSE_MAX_QUEUED_MESSAGES - #define SSE_MAX_QUEUED_MESSAGES 32 - #endif - #define SSE_MIN_INFLIGH 2 * 1460 // allow 2 MSS packets - #define SSE_MAX_INFLIGH 16 * 1024 // but no more than 16k, no need to blow it, since same data is kept in local Q +#include +#include +#ifndef SSE_MAX_QUEUED_MESSAGES +#define SSE_MAX_QUEUED_MESSAGES 32 +#endif +#define SSE_MIN_INFLIGH 2 * 1460 // allow 2 MSS packets +#define SSE_MAX_INFLIGH 16 * 1024 // but no more than 16k, no need to blow it, since same data is kept in local Q #elif defined(ESP8266) - #include - #ifndef SSE_MAX_QUEUED_MESSAGES - #define SSE_MAX_QUEUED_MESSAGES 8 - #endif - #define SSE_MIN_INFLIGH 2 * 1460 // allow 2 MSS packets - #define SSE_MAX_INFLIGH 8 * 1024 // but no more than 8k, no need to blow it, since same data is kept in local Q -#elif defined(TARGET_RP2040) - #include - #ifndef SSE_MAX_QUEUED_MESSAGES - #define SSE_MAX_QUEUED_MESSAGES 32 - #endif - #define SSE_MIN_INFLIGH 2 * 1460 // allow 2 MSS packets - #define SSE_MAX_INFLIGH 16 * 1024 // but no more than 16k, no need to blow it, since same data is kept in local Q +#include +#ifndef SSE_MAX_QUEUED_MESSAGES +#define SSE_MAX_QUEUED_MESSAGES 8 +#endif +#define SSE_MIN_INFLIGH 2 * 1460 // allow 2 MSS packets +#define SSE_MAX_INFLIGH 8 * 1024 // but no more than 8k, no need to blow it, since same data is kept in local Q +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#ifndef SSE_MAX_QUEUED_MESSAGES +#define SSE_MAX_QUEUED_MESSAGES 32 +#endif +#define SSE_MIN_INFLIGH 2 * 1460 // allow 2 MSS packets +#define SSE_MAX_INFLIGH 16 * 1024 // but no more than 16k, no need to blow it, since same data is kept in local Q #endif #include #ifdef ESP8266 - #include - #ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library - #include <../src/Hash.h> - #endif +#include +#ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library +#include <../src/Hash.h> +#endif #endif class AsyncEventSource; class AsyncEventSourceResponse; class AsyncEventSourceClient; -using ArEventHandlerFunction = std::function; +using ArEventHandlerFunction = std::function; using ArAuthorizeConnectHandler = ArAuthorizeFunction; // shared message object container using AsyncEvent_SharedData_t = std::shared_ptr; @@ -69,55 +53,67 @@ using AsyncEvent_SharedData_t = std::shared_ptr; */ class AsyncEventSourceMessage { - private: - const AsyncEvent_SharedData_t _data; - size_t _sent{0}; // num of bytes already sent - size_t _acked{0}; // num of bytes acked +private: + const AsyncEvent_SharedData_t _data; + size_t _sent{0}; // num of bytes already sent + size_t _acked{0}; // num of bytes acked - public: - AsyncEventSourceMessage(AsyncEvent_SharedData_t data) : _data(data) {}; -#ifdef ESP32 - AsyncEventSourceMessage(const char* data, size_t len) : _data(std::make_shared(data, len)) {}; +public: + AsyncEventSourceMessage(AsyncEvent_SharedData_t data) : _data(data){}; +#if defined(ESP32) + AsyncEventSourceMessage(const char *data, size_t len) : _data(std::make_shared(data, len)){}; +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) + AsyncEventSourceMessage(const char *data, size_t len) : _data(std::make_shared()) { + if (data && len > 0) { + _data->concat(data, len); + } + }; #else - // esp8266's String does not have constructor with data/length arguments. Use a concat method here - AsyncEventSourceMessage(const char* data, size_t len) { _data->concat(data, len); }; + // esp8266's String does not have constructor with data/length arguments. Use a concat method here + AsyncEventSourceMessage(const char *data, size_t len) { + _data->concat(data, len); + }; #endif - /** + /** * @brief acknowledge sending len bytes of data * @note if num of bytes to ack is larger then the unacknowledged message length the number of carried over bytes are returned * - * @param len bytes to acknowlegde + * @param len bytes to acknowledge * @param time * @return size_t number of extra bytes carried over */ - size_t ack(size_t len, uint32_t time = 0); + size_t ack(size_t len, uint32_t time = 0); - /** + /** * @brief write message data to client's buffer * @note this method does NOT call client's send * * @param client * @return size_t number of bytes written */ - size_t write(AsyncClient* client); + size_t write(AsyncClient *client); - /** + /** * @brief writes message data to client's buffer and calls client's send method * * @param client * @return size_t returns num of bytes the clien was able to send() */ - size_t send(AsyncClient* client); + size_t send(AsyncClient *client); - // returns true if full message's length were acked - bool finished() { return _acked == _data->length(); } + // returns true if full message's length were acked + bool finished() { + return _acked == _data->length(); + } - /** + /** * @brief returns true if all data has been sent already * */ - bool sent() { return _sent == _data->length(); } + bool sent() { + return _sent == _data->length(); + } }; /** @@ -125,25 +121,25 @@ class AsyncEventSourceMessage { * */ class AsyncEventSourceClient { - private: - AsyncClient* _client; - AsyncEventSource* _server; - uint32_t _lastId{0}; - size_t _inflight{0}; // num of unacknowledged bytes that has been written to socket buffer - size_t _max_inflight{SSE_MAX_INFLIGH}; // max num of unacknowledged bytes that could be written to socket buffer - std::list _messageQueue; +private: + AsyncClient *_client; + AsyncEventSource *_server; + uint32_t _lastId{0}; + size_t _inflight{0}; // num of unacknowledged bytes that has been written to socket buffer + size_t _max_inflight{SSE_MAX_INFLIGH}; // max num of unacknowledged bytes that could be written to socket buffer + std::list _messageQueue; #ifdef ESP32 - mutable std::mutex _lockmq; + mutable std::mutex _lockmq; #endif - bool _queueMessage(const char* message, size_t len); - bool _queueMessage(AsyncEvent_SharedData_t&& msg); - void _runQueue(); + bool _queueMessage(const char *message, size_t len); + bool _queueMessage(AsyncEvent_SharedData_t &&msg); + void _runQueue(); - public: - AsyncEventSourceClient(AsyncWebServerRequest* request, AsyncEventSource* server); - ~AsyncEventSourceClient(); +public: + AsyncEventSourceClient(AsyncWebServerRequest *request, AsyncEventSource *server); + ~AsyncEventSourceClient(); - /** + /** * @brief Send an SSE message to client * it will craft an SSE message and place it to client's message queue * @@ -154,11 +150,15 @@ class AsyncEventSourceClient { * @return true if message was placed in a queue * @return false if queue is full */ - bool send(const char* message, const char* event = NULL, uint32_t id = 0, uint32_t reconnect = 0); - bool send(const String& message, const String& event, uint32_t id = 0, uint32_t reconnect = 0) { return send(message.c_str(), event.c_str(), id, reconnect); } - bool send(const String& message, const char* event, uint32_t id = 0, uint32_t reconnect = 0) { return send(message.c_str(), event, id, reconnect); } + bool send(const char *message, const char *event = NULL, uint32_t id = 0, uint32_t reconnect = 0); + bool send(const String &message, const String &event, uint32_t id = 0, uint32_t reconnect = 0) { + return send(message.c_str(), event.c_str(), id, reconnect); + } + bool send(const String &message, const char *event, uint32_t id = 0, uint32_t reconnect = 0) { + return send(message.c_str(), event, id, reconnect); + } - /** + /** * @brief place supplied preformatted SSE message to the message queue * @note message must a properly formatted SSE string according to https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events * @@ -166,42 +166,56 @@ class AsyncEventSourceClient { * @return true on success * @return false on queue overflow or no client connected */ - bool write(AsyncEvent_SharedData_t message) { return connected() && _queueMessage(std::move(message)); }; + bool write(AsyncEvent_SharedData_t message) { + return connected() && _queueMessage(std::move(message)); + }; - [[deprecated("Use _write(AsyncEvent_SharedData_t message) instead to share same data with multiple SSE clients")]] - bool write(const char* message, size_t len) { return connected() && _queueMessage(message, len); }; + [[deprecated("Use _write(AsyncEvent_SharedData_t message) instead to share same data with multiple SSE clients")]] + bool write(const char *message, size_t len) { + return connected() && _queueMessage(message, len); + }; - // close client's connection - void close(); + // close client's connection + void close(); - // getters + // getters - AsyncClient* client() { return _client; } - bool connected() const { return _client && _client->connected(); } - uint32_t lastId() const { return _lastId; } - size_t packetsWaiting() const { return _messageQueue.size(); }; + AsyncClient *client() { + return _client; + } + bool connected() const { + return _client && _client->connected(); + } + uint32_t lastId() const { + return _lastId; + } + size_t packetsWaiting() const { + return _messageQueue.size(); + }; - /** + /** * @brief Sets max amount of bytes that could be written to client's socket while awaiting delivery acknowledge * used to throttle message delivery length to tradeoff memory consumption * @note actual amount of data written could possible be a bit larger but no more than available socket buff space * * @param value */ - void set_max_inflight_bytes(size_t value); + void set_max_inflight_bytes(size_t value); - /** + /** * @brief Get current max inflight bytes value * * @return size_t */ - size_t get_max_inflight_bytes() const { return _max_inflight; } + size_t get_max_inflight_bytes() const { + return _max_inflight; + } - // system callbacks (do not call if from user code!) - void _onAck(size_t len, uint32_t time); - void _onPoll(); - void _onTimeout(uint32_t time); - void _onDisconnect(); + // system callbacks (do not call if from user code!) + void _onAck(size_t len, uint32_t time); + void _onPoll(); + void _onTimeout(uint32_t time); + void _onDisconnect(); }; /** @@ -210,44 +224,50 @@ class AsyncEventSourceClient { * */ class AsyncEventSource : public AsyncWebHandler { - private: - String _url; - std::list> _clients; +private: + String _url; + std::list> _clients; #ifdef ESP32 - // Same as for individual messages, protect mutations of _clients list - // since simultaneous access from different tasks is possible - mutable std::mutex _client_queue_lock; + // Same as for individual messages, protect mutations of _clients list + // since simultaneous access from different tasks is possible + mutable std::mutex _client_queue_lock; #endif - ArEventHandlerFunction _connectcb = nullptr; - ArEventHandlerFunction _disconnectcb = nullptr; + ArEventHandlerFunction _connectcb = nullptr; + ArEventHandlerFunction _disconnectcb = nullptr; - // this method manipulates in-fligh data size for connected client depending on number of active connections - void _adjust_inflight_window(); + // this method manipulates in-fligh data size for connected client depending on number of active connections + void _adjust_inflight_window(); - public: - typedef enum { - DISCARDED = 0, - ENQUEUED = 1, - PARTIALLY_ENQUEUED = 2, - } SendStatus; +public: + typedef enum { + DISCARDED = 0, + ENQUEUED = 1, + PARTIALLY_ENQUEUED = 2, + } SendStatus; - AsyncEventSource(const char* url) : _url(url) {}; - AsyncEventSource(const String& url) : _url(url) {}; - ~AsyncEventSource() { close(); }; + AsyncEventSource(const char *url) : _url(url){}; + AsyncEventSource(const String &url) : _url(url){}; + ~AsyncEventSource() { + close(); + }; - const char* url() const { return _url.c_str(); } - // close all connected clients - void close(); + const char *url() const { + return _url.c_str(); + } + // close all connected clients + void close(); - /** + /** * @brief set on-connect callback for the client * used to deliver messages to client on first connect * * @param cb */ - void onConnect(ArEventHandlerFunction cb) { _connectcb = cb; } + void onConnect(ArEventHandlerFunction cb) { + _connectcb = cb; + } - /** + /** * @brief Send an SSE message to client * it will craft an SSE message and place it to all connected client's message queues * @@ -257,36 +277,44 @@ class AsyncEventSource : public AsyncWebHandler { * @param reconnect client's reconnect timeout * @return SendStatus if message was placed in any/all/part of the client's queues */ - SendStatus send(const char* message, const char* event = NULL, uint32_t id = 0, uint32_t reconnect = 0); - SendStatus send(const String& message, const String& event, uint32_t id = 0, uint32_t reconnect = 0) { return send(message.c_str(), event.c_str(), id, reconnect); } - SendStatus send(const String& message, const char* event, uint32_t id = 0, uint32_t reconnect = 0) { return send(message.c_str(), event, id, reconnect); } + SendStatus send(const char *message, const char *event = NULL, uint32_t id = 0, uint32_t reconnect = 0); + SendStatus send(const String &message, const String &event, uint32_t id = 0, uint32_t reconnect = 0) { + return send(message.c_str(), event.c_str(), id, reconnect); + } + SendStatus send(const String &message, const char *event, uint32_t id = 0, uint32_t reconnect = 0) { + return send(message.c_str(), event, id, reconnect); + } - // The client pointer sent to the callback is only for reference purposes. DO NOT CALL ANY METHOD ON IT ! - void onDisconnect(ArEventHandlerFunction cb) { _disconnectcb = cb; } - void authorizeConnect(ArAuthorizeConnectHandler cb); + // The client pointer sent to the callback is only for reference purposes. DO NOT CALL ANY METHOD ON IT ! + void onDisconnect(ArEventHandlerFunction cb) { + _disconnectcb = cb; + } + void authorizeConnect(ArAuthorizeConnectHandler cb); - // returns number of connected clients - size_t count() const; + // returns number of connected clients + size_t count() const; - // returns average number of messages pending in all client's queues - size_t avgPacketsWaiting() const; + // returns average number of messages pending in all client's queues + size_t avgPacketsWaiting() const; - // system callbacks (do not call from user code!) - void _addClient(AsyncEventSourceClient* client); - void _handleDisconnect(AsyncEventSourceClient* client); - bool canHandle(AsyncWebServerRequest* request) const override final; - void handleRequest(AsyncWebServerRequest* request) override final; + // system callbacks (do not call from user code!) + void _addClient(AsyncEventSourceClient *client); + void _handleDisconnect(AsyncEventSourceClient *client); + bool canHandle(AsyncWebServerRequest *request) const override final; + void handleRequest(AsyncWebServerRequest *request) override final; }; class AsyncEventSourceResponse : public AsyncWebServerResponse { - private: - AsyncEventSource* _server; +private: + AsyncEventSource *_server; - public: - AsyncEventSourceResponse(AsyncEventSource* server); - void _respond(AsyncWebServerRequest* request); - size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time); - bool _sourceValid() const { return true; } +public: + AsyncEventSourceResponse(AsyncEventSource *server); + void _respond(AsyncWebServerRequest *request); + size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); + bool _sourceValid() const { + return true; + } }; #endif /* ASYNCEVENTSOURCE_H_ */ diff --git a/src/AsyncJson.cpp b/src/AsyncJson.cpp index 4295653..b8d014b 100644 --- a/src/AsyncJson.cpp +++ b/src/AsyncJson.cpp @@ -1,108 +1,117 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #include "AsyncJson.h" #if ASYNC_JSON_SUPPORT == 1 - #if ARDUINOJSON_VERSION_MAJOR == 5 +#if ARDUINOJSON_VERSION_MAJOR == 5 AsyncJsonResponse::AsyncJsonResponse(bool isArray) : _isValid{false} { _code = 200; _contentType = asyncsrv::T_application_json; - if (isArray) + if (isArray) { _root = _jsonBuffer.createArray(); - else + } else { _root = _jsonBuffer.createObject(); + } } - #elif ARDUINOJSON_VERSION_MAJOR == 6 +#elif ARDUINOJSON_VERSION_MAJOR == 6 AsyncJsonResponse::AsyncJsonResponse(bool isArray, size_t maxJsonBufferSize) : _jsonBuffer(maxJsonBufferSize), _isValid{false} { _code = 200; _contentType = asyncsrv::T_application_json; - if (isArray) + if (isArray) { _root = _jsonBuffer.createNestedArray(); - else + } else { _root = _jsonBuffer.createNestedObject(); + } } - #else +#else AsyncJsonResponse::AsyncJsonResponse(bool isArray) : _isValid{false} { _code = 200; _contentType = asyncsrv::T_application_json; - if (isArray) + if (isArray) { _root = _jsonBuffer.add(); - else + } else { _root = _jsonBuffer.add(); + } } - #endif +#endif size_t AsyncJsonResponse::setLength() { - #if ARDUINOJSON_VERSION_MAJOR == 5 +#if ARDUINOJSON_VERSION_MAJOR == 5 _contentLength = _root.measureLength(); - #else +#else _contentLength = measureJson(_root); - #endif +#endif if (_contentLength) { _isValid = true; } return _contentLength; } -size_t AsyncJsonResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t AsyncJsonResponse::_fillBuffer(uint8_t *data, size_t len) { ChunkPrint dest(data, _sentLength, len); - #if ARDUINOJSON_VERSION_MAJOR == 5 +#if ARDUINOJSON_VERSION_MAJOR == 5 _root.printTo(dest); - #else +#else serializeJson(_root, dest); - #endif +#endif return len; } - #if ARDUINOJSON_VERSION_MAJOR == 6 +#if ARDUINOJSON_VERSION_MAJOR == 6 PrettyAsyncJsonResponse::PrettyAsyncJsonResponse(bool isArray, size_t maxJsonBufferSize) : AsyncJsonResponse{isArray, maxJsonBufferSize} {} - #else +#else PrettyAsyncJsonResponse::PrettyAsyncJsonResponse(bool isArray) : AsyncJsonResponse{isArray} {} - #endif +#endif size_t PrettyAsyncJsonResponse::setLength() { - #if ARDUINOJSON_VERSION_MAJOR == 5 +#if ARDUINOJSON_VERSION_MAJOR == 5 _contentLength = _root.measurePrettyLength(); - #else +#else _contentLength = measureJsonPretty(_root); - #endif +#endif if (_contentLength) { _isValid = true; } return _contentLength; } -size_t PrettyAsyncJsonResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t PrettyAsyncJsonResponse::_fillBuffer(uint8_t *data, size_t len) { ChunkPrint dest(data, _sentLength, len); - #if ARDUINOJSON_VERSION_MAJOR == 5 +#if ARDUINOJSON_VERSION_MAJOR == 5 _root.prettyPrintTo(dest); - #else +#else serializeJsonPretty(_root, dest); - #endif +#endif return len; } - #if ARDUINOJSON_VERSION_MAJOR == 6 -AsyncCallbackJsonWebHandler::AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest, size_t maxJsonBufferSize) - : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), maxJsonBufferSize(maxJsonBufferSize), _maxContentLength(16384) {} - #else -AsyncCallbackJsonWebHandler::AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest) - : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {} - #endif +#if ARDUINOJSON_VERSION_MAJOR == 6 +AsyncCallbackJsonWebHandler::AsyncCallbackJsonWebHandler(const String &uri, ArJsonRequestHandlerFunction onRequest, size_t maxJsonBufferSize) + : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), maxJsonBufferSize(maxJsonBufferSize), _maxContentLength(16384) {} +#else +AsyncCallbackJsonWebHandler::AsyncCallbackJsonWebHandler(const String &uri, ArJsonRequestHandlerFunction onRequest) + : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {} +#endif -bool AsyncCallbackJsonWebHandler::canHandle(AsyncWebServerRequest* request) const { - if (!_onRequest || !request->isHTTP() || !(_method & request->method())) +bool AsyncCallbackJsonWebHandler::canHandle(AsyncWebServerRequest *request) const { + if (!_onRequest || !request->isHTTP() || !(_method & request->method())) { return false; + } - if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/"))) + if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/"))) { return false; + } - if (request->method() != HTTP_GET && !request->contentType().equalsIgnoreCase(asyncsrv::T_application_json)) + if (request->method() != HTTP_GET && !request->contentType().equalsIgnoreCase(asyncsrv::T_application_json)) { return false; + } return true; } -void AsyncCallbackJsonWebHandler::handleRequest(AsyncWebServerRequest* request) { +void AsyncCallbackJsonWebHandler::handleRequest(AsyncWebServerRequest *request) { if (_onRequest) { if (request->method() == HTTP_GET) { JsonVariant json; @@ -110,21 +119,21 @@ void AsyncCallbackJsonWebHandler::handleRequest(AsyncWebServerRequest* request) return; } else if (request->_tempObject != NULL) { - #if ARDUINOJSON_VERSION_MAJOR == 5 +#if ARDUINOJSON_VERSION_MAJOR == 5 DynamicJsonBuffer jsonBuffer; - JsonVariant json = jsonBuffer.parse((uint8_t*)(request->_tempObject)); + JsonVariant json = jsonBuffer.parse((uint8_t *)(request->_tempObject)); if (json.success()) { - #elif ARDUINOJSON_VERSION_MAJOR == 6 +#elif ARDUINOJSON_VERSION_MAJOR == 6 DynamicJsonDocument jsonBuffer(this->maxJsonBufferSize); - DeserializationError error = deserializeJson(jsonBuffer, (uint8_t*)(request->_tempObject)); + DeserializationError error = deserializeJson(jsonBuffer, (uint8_t *)(request->_tempObject)); if (!error) { JsonVariant json = jsonBuffer.as(); - #else +#else JsonDocument jsonBuffer; - DeserializationError error = deserializeJson(jsonBuffer, (uint8_t*)(request->_tempObject)); + DeserializationError error = deserializeJson(jsonBuffer, (uint8_t *)(request->_tempObject)); if (!error) { JsonVariant json = jsonBuffer.as(); - #endif +#endif _onRequest(request, json); return; @@ -136,16 +145,23 @@ void AsyncCallbackJsonWebHandler::handleRequest(AsyncWebServerRequest* request) } } -void AsyncCallbackJsonWebHandler::handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) { +void AsyncCallbackJsonWebHandler::handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) { if (_onRequest) { _contentLength = total; if (total > 0 && request->_tempObject == NULL && total < _maxContentLength) { request->_tempObject = malloc(total); + if (request->_tempObject == NULL) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + request->abort(); + return; + } } if (request->_tempObject != NULL) { - memcpy((uint8_t*)(request->_tempObject) + index, data, len); + memcpy((uint8_t *)(request->_tempObject) + index, data, len); } } } -#endif // ASYNC_JSON_SUPPORT +#endif // ASYNC_JSON_SUPPORT diff --git a/src/AsyncJson.h b/src/AsyncJson.h index a54935a..b5777d6 100644 --- a/src/AsyncJson.h +++ b/src/AsyncJson.h @@ -1,131 +1,119 @@ -// AsyncJson.h -/* - Async Response to use with ArduinoJson and AsyncWebServer - Written by Andrew Melvin (SticilFace) with help from me-no-dev and BBlanchon. +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Example of callback in use - - server.on("/json", HTTP_ANY, [](AsyncWebServerRequest * request) { - - AsyncJsonResponse * response = new AsyncJsonResponse(); - JsonObject& root = response->getRoot(); - root["key1"] = "key number one"; - JsonObject& nested = root.createNestedObject("nested"); - nested["key1"] = "key number one"; - - response->setLength(); - request->send(response); - }); - - -------------------- - - Async Request to use with ArduinoJson and AsyncWebServer - Written by Arsène von Wyss (avonwyss) - - Example - - AsyncCallbackJsonWebHandler* handler = new AsyncCallbackJsonWebHandler("/rest/endpoint"); - handler->onRequest([](AsyncWebServerRequest *request, JsonVariant &json) { - JsonObject jsonObj = json.as(); - // ... - }); - server.addHandler(handler); - -*/ #ifndef ASYNC_JSON_H_ #define ASYNC_JSON_H_ #if __has_include("ArduinoJson.h") - #include - #if ARDUINOJSON_VERSION_MAJOR >= 5 - #define ASYNC_JSON_SUPPORT 1 - #else - #define ASYNC_JSON_SUPPORT 0 - #endif // ARDUINOJSON_VERSION_MAJOR >= 5 -#endif // __has_include("ArduinoJson.h") +#include +#if ARDUINOJSON_VERSION_MAJOR >= 5 +#define ASYNC_JSON_SUPPORT 1 +#else +#define ASYNC_JSON_SUPPORT 0 +#endif // ARDUINOJSON_VERSION_MAJOR >= 5 +#endif // __has_include("ArduinoJson.h") #if ASYNC_JSON_SUPPORT == 1 - #include +#include - #include "ChunkPrint.h" +#include "ChunkPrint.h" - #if ARDUINOJSON_VERSION_MAJOR == 6 - #ifndef DYNAMIC_JSON_DOCUMENT_SIZE - #define DYNAMIC_JSON_DOCUMENT_SIZE 1024 - #endif - #endif +#if ARDUINOJSON_VERSION_MAJOR == 6 +#ifndef DYNAMIC_JSON_DOCUMENT_SIZE +#define DYNAMIC_JSON_DOCUMENT_SIZE 1024 +#endif +#endif class AsyncJsonResponse : public AsyncAbstractResponse { - protected: - #if ARDUINOJSON_VERSION_MAJOR == 5 - DynamicJsonBuffer _jsonBuffer; - #elif ARDUINOJSON_VERSION_MAJOR == 6 - DynamicJsonDocument _jsonBuffer; - #else - JsonDocument _jsonBuffer; - #endif +protected: +#if ARDUINOJSON_VERSION_MAJOR == 5 + DynamicJsonBuffer _jsonBuffer; +#elif ARDUINOJSON_VERSION_MAJOR == 6 + DynamicJsonDocument _jsonBuffer; +#else + JsonDocument _jsonBuffer; +#endif - JsonVariant _root; - bool _isValid; + JsonVariant _root; + bool _isValid; - public: - #if ARDUINOJSON_VERSION_MAJOR == 6 - AsyncJsonResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); - #else - AsyncJsonResponse(bool isArray = false); - #endif - JsonVariant& getRoot() { return _root; } - bool _sourceValid() const { return _isValid; } - size_t setLength(); - size_t getSize() const { return _jsonBuffer.size(); } - size_t _fillBuffer(uint8_t* data, size_t len); - #if ARDUINOJSON_VERSION_MAJOR >= 6 - bool overflowed() const { return _jsonBuffer.overflowed(); } - #endif +public: +#if ARDUINOJSON_VERSION_MAJOR == 6 + AsyncJsonResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); +#else + AsyncJsonResponse(bool isArray = false); +#endif + JsonVariant &getRoot() { + return _root; + } + bool _sourceValid() const { + return _isValid; + } + size_t setLength(); + size_t getSize() const { + return _jsonBuffer.size(); + } + size_t _fillBuffer(uint8_t *data, size_t len); +#if ARDUINOJSON_VERSION_MAJOR >= 6 + bool overflowed() const { + return _jsonBuffer.overflowed(); + } +#endif }; class PrettyAsyncJsonResponse : public AsyncJsonResponse { - public: - #if ARDUINOJSON_VERSION_MAJOR == 6 - PrettyAsyncJsonResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); - #else - PrettyAsyncJsonResponse(bool isArray = false); - #endif - size_t setLength(); - size_t _fillBuffer(uint8_t* data, size_t len); +public: +#if ARDUINOJSON_VERSION_MAJOR == 6 + PrettyAsyncJsonResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); +#else + PrettyAsyncJsonResponse(bool isArray = false); +#endif + size_t setLength(); + size_t _fillBuffer(uint8_t *data, size_t len); }; -typedef std::function ArJsonRequestHandlerFunction; +typedef std::function ArJsonRequestHandlerFunction; class AsyncCallbackJsonWebHandler : public AsyncWebHandler { - protected: - String _uri; - WebRequestMethodComposite _method; - ArJsonRequestHandlerFunction _onRequest; - size_t _contentLength; - #if ARDUINOJSON_VERSION_MAJOR == 6 - size_t maxJsonBufferSize; - #endif - size_t _maxContentLength; +protected: + String _uri; + WebRequestMethodComposite _method; + ArJsonRequestHandlerFunction _onRequest; + size_t _contentLength; +#if ARDUINOJSON_VERSION_MAJOR == 6 + size_t maxJsonBufferSize; +#endif + size_t _maxContentLength; - public: - #if ARDUINOJSON_VERSION_MAJOR == 6 - AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest = nullptr, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); - #else - AsyncCallbackJsonWebHandler(const String& uri, ArJsonRequestHandlerFunction onRequest = nullptr); - #endif +public: +#if ARDUINOJSON_VERSION_MAJOR == 6 + AsyncCallbackJsonWebHandler(const String &uri, ArJsonRequestHandlerFunction onRequest = nullptr, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); +#else + AsyncCallbackJsonWebHandler(const String &uri, ArJsonRequestHandlerFunction onRequest = nullptr); +#endif - void setMethod(WebRequestMethodComposite method) { _method = method; } - void setMaxContentLength(int maxContentLength) { _maxContentLength = maxContentLength; } - void onRequest(ArJsonRequestHandlerFunction fn) { _onRequest = fn; } + void setMethod(WebRequestMethodComposite method) { + _method = method; + } + void setMaxContentLength(int maxContentLength) { + _maxContentLength = maxContentLength; + } + void onRequest(ArJsonRequestHandlerFunction fn) { + _onRequest = fn; + } - bool canHandle(AsyncWebServerRequest* request) const override final; - void handleRequest(AsyncWebServerRequest* request) override final; - void handleUpload(__unused AsyncWebServerRequest* request, __unused const String& filename, __unused size_t index, __unused uint8_t* data, __unused size_t len, __unused bool final) override final {} - void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final; - bool isRequestHandlerTrivial() const override final { return !_onRequest; } + bool canHandle(AsyncWebServerRequest *request) const override final; + void handleRequest(AsyncWebServerRequest *request) override final; + void handleUpload( + __unused AsyncWebServerRequest *request, __unused const String &filename, __unused size_t index, __unused uint8_t *data, __unused size_t len, + __unused bool final + ) override final {} + void handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) override final; + bool isRequestHandlerTrivial() const override final { + return !_onRequest; + } }; -#endif // ASYNC_JSON_SUPPORT == 1 +#endif // ASYNC_JSON_SUPPORT == 1 -#endif // ASYNC_JSON_H_ +#endif // ASYNC_JSON_H_ diff --git a/src/AsyncMessagePack.cpp b/src/AsyncMessagePack.cpp index 85af671..0c6faa1 100644 --- a/src/AsyncMessagePack.cpp +++ b/src/AsyncMessagePack.cpp @@ -1,26 +1,31 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #include "AsyncMessagePack.h" #if ASYNC_MSG_PACK_SUPPORT == 1 - #if ARDUINOJSON_VERSION_MAJOR == 6 +#if ARDUINOJSON_VERSION_MAJOR == 6 AsyncMessagePackResponse::AsyncMessagePackResponse(bool isArray, size_t maxJsonBufferSize) : _jsonBuffer(maxJsonBufferSize), _isValid{false} { _code = 200; _contentType = asyncsrv::T_application_msgpack; - if (isArray) + if (isArray) { _root = _jsonBuffer.createNestedArray(); - else + } else { _root = _jsonBuffer.createNestedObject(); + } } - #else +#else AsyncMessagePackResponse::AsyncMessagePackResponse(bool isArray) : _isValid{false} { _code = 200; _contentType = asyncsrv::T_application_msgpack; - if (isArray) + if (isArray) { _root = _jsonBuffer.add(); - else + } else { _root = _jsonBuffer.add(); + } } - #endif +#endif size_t AsyncMessagePackResponse::setLength() { _contentLength = measureMsgPack(_root); @@ -30,34 +35,39 @@ size_t AsyncMessagePackResponse::setLength() { return _contentLength; } -size_t AsyncMessagePackResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t AsyncMessagePackResponse::_fillBuffer(uint8_t *data, size_t len) { ChunkPrint dest(data, _sentLength, len); serializeMsgPack(_root, dest); return len; } - #if ARDUINOJSON_VERSION_MAJOR == 6 -AsyncCallbackMessagePackWebHandler::AsyncCallbackMessagePackWebHandler(const String& uri, ArMessagePackRequestHandlerFunction onRequest, size_t maxJsonBufferSize) - : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), maxJsonBufferSize(maxJsonBufferSize), _maxContentLength(16384) {} - #else -AsyncCallbackMessagePackWebHandler::AsyncCallbackMessagePackWebHandler(const String& uri, ArMessagePackRequestHandlerFunction onRequest) - : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {} - #endif +#if ARDUINOJSON_VERSION_MAJOR == 6 +AsyncCallbackMessagePackWebHandler::AsyncCallbackMessagePackWebHandler( + const String &uri, ArMessagePackRequestHandlerFunction onRequest, size_t maxJsonBufferSize +) + : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), maxJsonBufferSize(maxJsonBufferSize), _maxContentLength(16384) {} +#else +AsyncCallbackMessagePackWebHandler::AsyncCallbackMessagePackWebHandler(const String &uri, ArMessagePackRequestHandlerFunction onRequest) + : _uri(uri), _method(HTTP_GET | HTTP_POST | HTTP_PUT | HTTP_PATCH), _onRequest(onRequest), _maxContentLength(16384) {} +#endif -bool AsyncCallbackMessagePackWebHandler::canHandle(AsyncWebServerRequest* request) const { - if (!_onRequest || !request->isHTTP() || !(_method & request->method())) +bool AsyncCallbackMessagePackWebHandler::canHandle(AsyncWebServerRequest *request) const { + if (!_onRequest || !request->isHTTP() || !(_method & request->method())) { return false; + } - if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/"))) + if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/"))) { return false; + } - if (request->method() != HTTP_GET && !request->contentType().equalsIgnoreCase(asyncsrv::T_application_msgpack)) + if (request->method() != HTTP_GET && !request->contentType().equalsIgnoreCase(asyncsrv::T_application_msgpack)) { return false; + } return true; } -void AsyncCallbackMessagePackWebHandler::handleRequest(AsyncWebServerRequest* request) { +void AsyncCallbackMessagePackWebHandler::handleRequest(AsyncWebServerRequest *request) { if (_onRequest) { if (request->method() == HTTP_GET) { JsonVariant json; @@ -65,17 +75,17 @@ void AsyncCallbackMessagePackWebHandler::handleRequest(AsyncWebServerRequest* re return; } else if (request->_tempObject != NULL) { - #if ARDUINOJSON_VERSION_MAJOR == 6 +#if ARDUINOJSON_VERSION_MAJOR == 6 DynamicJsonDocument jsonBuffer(this->maxJsonBufferSize); - DeserializationError error = deserializeMsgPack(jsonBuffer, (uint8_t*)(request->_tempObject)); + DeserializationError error = deserializeMsgPack(jsonBuffer, (uint8_t *)(request->_tempObject)); if (!error) { JsonVariant json = jsonBuffer.as(); - #else +#else JsonDocument jsonBuffer; - DeserializationError error = deserializeMsgPack(jsonBuffer, (uint8_t*)(request->_tempObject)); + DeserializationError error = deserializeMsgPack(jsonBuffer, (uint8_t *)(request->_tempObject)); if (!error) { JsonVariant json = jsonBuffer.as(); - #endif +#endif _onRequest(request, json); return; @@ -87,16 +97,23 @@ void AsyncCallbackMessagePackWebHandler::handleRequest(AsyncWebServerRequest* re } } -void AsyncCallbackMessagePackWebHandler::handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) { +void AsyncCallbackMessagePackWebHandler::handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) { if (_onRequest) { _contentLength = total; if (total > 0 && request->_tempObject == NULL && total < _maxContentLength) { request->_tempObject = malloc(total); + if (request->_tempObject == NULL) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + request->abort(); + return; + } } if (request->_tempObject != NULL) { - memcpy((uint8_t*)(request->_tempObject) + index, data, len); + memcpy((uint8_t *)(request->_tempObject) + index, data, len); } } } -#endif // ASYNC_MSG_PACK_SUPPORT +#endif // ASYNC_MSG_PACK_SUPPORT diff --git a/src/AsyncMessagePack.h b/src/AsyncMessagePack.h index 78fde92..7488b5c 100644 --- a/src/AsyncMessagePack.h +++ b/src/AsyncMessagePack.h @@ -1,3 +1,6 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #pragma once /* @@ -22,81 +25,102 @@ */ #if __has_include("ArduinoJson.h") - #include - #if ARDUINOJSON_VERSION_MAJOR >= 6 - #define ASYNC_MSG_PACK_SUPPORT 1 - #else - #define ASYNC_MSG_PACK_SUPPORT 0 - #endif // ARDUINOJSON_VERSION_MAJOR >= 6 -#endif // __has_include("ArduinoJson.h") +#include +#if ARDUINOJSON_VERSION_MAJOR >= 6 +#define ASYNC_MSG_PACK_SUPPORT 1 +#else +#define ASYNC_MSG_PACK_SUPPORT 0 +#endif // ARDUINOJSON_VERSION_MAJOR >= 6 +#endif // __has_include("ArduinoJson.h") #if ASYNC_MSG_PACK_SUPPORT == 1 - #include +#include - #include "ChunkPrint.h" +#include "ChunkPrint.h" - #if ARDUINOJSON_VERSION_MAJOR == 6 - #ifndef DYNAMIC_JSON_DOCUMENT_SIZE - #define DYNAMIC_JSON_DOCUMENT_SIZE 1024 - #endif - #endif +#if ARDUINOJSON_VERSION_MAJOR == 6 +#ifndef DYNAMIC_JSON_DOCUMENT_SIZE +#define DYNAMIC_JSON_DOCUMENT_SIZE 1024 +#endif +#endif class AsyncMessagePackResponse : public AsyncAbstractResponse { - protected: - #if ARDUINOJSON_VERSION_MAJOR == 6 - DynamicJsonDocument _jsonBuffer; - #else - JsonDocument _jsonBuffer; - #endif +protected: +#if ARDUINOJSON_VERSION_MAJOR == 6 + DynamicJsonDocument _jsonBuffer; +#else + JsonDocument _jsonBuffer; +#endif - JsonVariant _root; - bool _isValid; + JsonVariant _root; + bool _isValid; - public: - #if ARDUINOJSON_VERSION_MAJOR == 6 - AsyncMessagePackResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); - #else - AsyncMessagePackResponse(bool isArray = false); - #endif - JsonVariant& getRoot() { return _root; } - bool _sourceValid() const { return _isValid; } - size_t setLength(); - size_t getSize() const { return _jsonBuffer.size(); } - size_t _fillBuffer(uint8_t* data, size_t len); - #if ARDUINOJSON_VERSION_MAJOR >= 6 - bool overflowed() const { return _jsonBuffer.overflowed(); } - #endif +public: +#if ARDUINOJSON_VERSION_MAJOR == 6 + AsyncMessagePackResponse(bool isArray = false, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); +#else + AsyncMessagePackResponse(bool isArray = false); +#endif + JsonVariant &getRoot() { + return _root; + } + bool _sourceValid() const { + return _isValid; + } + size_t setLength(); + size_t getSize() const { + return _jsonBuffer.size(); + } + size_t _fillBuffer(uint8_t *data, size_t len); +#if ARDUINOJSON_VERSION_MAJOR >= 6 + bool overflowed() const { + return _jsonBuffer.overflowed(); + } +#endif }; -typedef std::function ArMessagePackRequestHandlerFunction; +typedef std::function ArMessagePackRequestHandlerFunction; class AsyncCallbackMessagePackWebHandler : public AsyncWebHandler { - protected: - String _uri; - WebRequestMethodComposite _method; - ArMessagePackRequestHandlerFunction _onRequest; - size_t _contentLength; - #if ARDUINOJSON_VERSION_MAJOR == 6 - size_t maxJsonBufferSize; - #endif - size_t _maxContentLength; +protected: + String _uri; + WebRequestMethodComposite _method; + ArMessagePackRequestHandlerFunction _onRequest; + size_t _contentLength; +#if ARDUINOJSON_VERSION_MAJOR == 6 + size_t maxJsonBufferSize; +#endif + size_t _maxContentLength; - public: - #if ARDUINOJSON_VERSION_MAJOR == 6 - AsyncCallbackMessagePackWebHandler(const String& uri, ArMessagePackRequestHandlerFunction onRequest = nullptr, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE); - #else - AsyncCallbackMessagePackWebHandler(const String& uri, ArMessagePackRequestHandlerFunction onRequest = nullptr); - #endif +public: +#if ARDUINOJSON_VERSION_MAJOR == 6 + AsyncCallbackMessagePackWebHandler( + const String &uri, ArMessagePackRequestHandlerFunction onRequest = nullptr, size_t maxJsonBufferSize = DYNAMIC_JSON_DOCUMENT_SIZE + ); +#else + AsyncCallbackMessagePackWebHandler(const String &uri, ArMessagePackRequestHandlerFunction onRequest = nullptr); +#endif - void setMethod(WebRequestMethodComposite method) { _method = method; } - void setMaxContentLength(int maxContentLength) { _maxContentLength = maxContentLength; } - void onRequest(ArMessagePackRequestHandlerFunction fn) { _onRequest = fn; } + void setMethod(WebRequestMethodComposite method) { + _method = method; + } + void setMaxContentLength(int maxContentLength) { + _maxContentLength = maxContentLength; + } + void onRequest(ArMessagePackRequestHandlerFunction fn) { + _onRequest = fn; + } - bool canHandle(AsyncWebServerRequest* request) const override final; - void handleRequest(AsyncWebServerRequest* request) override final; - void handleUpload(__unused AsyncWebServerRequest* request, __unused const String& filename, __unused size_t index, __unused uint8_t* data, __unused size_t len, __unused bool final) override final {} - void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final; - bool isRequestHandlerTrivial() const override final { return !_onRequest; } + bool canHandle(AsyncWebServerRequest *request) const override final; + void handleRequest(AsyncWebServerRequest *request) override final; + void handleUpload( + __unused AsyncWebServerRequest *request, __unused const String &filename, __unused size_t index, __unused uint8_t *data, __unused size_t len, + __unused bool final + ) override final {} + void handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) override final; + bool isRequestHandlerTrivial() const override final { + return !_onRequest; + } }; -#endif // ASYNC_MSG_PACK_SUPPORT == 1 +#endif // ASYNC_MSG_PACK_SUPPORT == 1 diff --git a/src/AsyncWebHeader.cpp b/src/AsyncWebHeader.cpp index ba271a3..6d82f74 100644 --- a/src/AsyncWebHeader.cpp +++ b/src/AsyncWebHeader.cpp @@ -1,22 +1,32 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #include -AsyncWebHeader::AsyncWebHeader(const String& data) { - if (!data) +AsyncWebHeader::AsyncWebHeader(const String &data) { + if (!data) { return; + } int index = data.indexOf(':'); - if (index < 0) + if (index < 0) { return; + } _name = data.substring(0, index); _value = data.substring(index + 2); } String AsyncWebHeader::toString() const { String str; - str.reserve(_name.length() + _value.length() + 2); - str.concat(_name); - str.concat((char)0x3a); - str.concat((char)0x20); - str.concat(_value); - str.concat(asyncsrv::T_rn); + if (str.reserve(_name.length() + _value.length() + 2)) { + str.concat(_name); + str.concat((char)0x3a); + str.concat((char)0x20); + str.concat(_value); + str.concat(asyncsrv::T_rn); + } else { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + } return str; } diff --git a/src/AsyncWebServerVersion.h b/src/AsyncWebServerVersion.h new file mode 100644 index 0000000..35aeba3 --- /dev/null +++ b/src/AsyncWebServerVersion.h @@ -0,0 +1,40 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + +#pragma once + +#ifdef __cplusplus +extern "C" { +#endif + +/** Major version number (X.x.x) */ +#define ASYNCWEBSERVER_VERSION_MAJOR 3 +/** Minor version number (x.X.x) */ +#define ASYNCWEBSERVER_VERSION_MINOR 7 +/** Patch version number (x.x.X) */ +#define ASYNCWEBSERVER_VERSION_PATCH 2 + +/** + * Macro to convert version number into an integer + * + * To be used in comparisons, such as ASYNCWEBSERVER_VERSION >= ASYNCWEBSERVER_VERSION_VAL(2, 0, 0) + */ +#define ASYNCWEBSERVER_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch)) + +/** + * Current version, as an integer + * + * To be used in comparisons, such as ASYNCWEBSERVER_VERSION_NUM >= ASYNCWEBSERVER_VERSION_VAL(2, 0, 0) + */ +#define ASYNCWEBSERVER_VERSION_NUM ASYNCWEBSERVER_VERSION_VAL(ASYNCWEBSERVER_VERSION_MAJOR, ASYNCWEBSERVER_VERSION_MINOR, ASYNCWEBSERVER_VERSION_PATCH) + +/** + * Current version, as string + */ +#define df2xstr(s) #s +#define df2str(s) df2xstr(s) +#define ASYNCWEBSERVER_VERSION df2str(ASYNCWEBSERVER_VERSION_MAJOR) "." df2str(ASYNCWEBSERVER_VERSION_MINOR) "." df2str(ASYNCWEBSERVER_VERSION_PATCH) + +#ifdef __cplusplus +} +#endif diff --git a/src/AsyncWebSocket.cpp b/src/AsyncWebSocket.cpp index 9deb74a..3f91ae7 100644 --- a/src/AsyncWebSocket.cpp +++ b/src/AsyncWebSocket.cpp @@ -1,23 +1,6 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #include "AsyncWebSocket.h" #include "Arduino.h" @@ -26,28 +9,30 @@ #include #if defined(ESP32) - #if ESP_IDF_VERSION_MAJOR < 5 - #include "BackPort_SHA1Builder.h" - #else - #include - #endif - #include -#elif defined(TARGET_RP2040) || defined(ESP8266) - #include +#if ESP_IDF_VERSION_MAJOR < 5 +#include "BackPort_SHA1Builder.h" +#else +#include +#endif +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) || defined(ESP8266) +#include #endif using namespace asyncsrv; -size_t webSocketSendFrameWindow(AsyncClient* client) { - if (!client || !client->canSend()) +size_t webSocketSendFrameWindow(AsyncClient *client) { + if (!client || !client->canSend()) { return 0; + } size_t space = client->space(); - if (space < 9) + if (space < 9) { return 0; + } return space - 8; } -size_t webSocketSendFrame(AsyncClient* client, bool final, uint8_t opcode, bool mask, uint8_t* data, size_t len) { +size_t webSocketSendFrame(AsyncClient *client, bool final, uint8_t opcode, bool mask, uint8_t *data, size_t len) { if (!client || !client->canSend()) { // Serial.println("SF 1"); return 0; @@ -66,30 +51,35 @@ size_t webSocketSendFrame(AsyncClient* client, bool final, uint8_t opcode, bool mbuf[2] = rand() % 0xFF; mbuf[3] = rand() % 0xFF; } - if (len > 125) + if (len > 125) { headLen += 2; + } if (space < headLen) { // Serial.println("SF 2"); return 0; } space -= headLen; - if (len > space) + if (len > space) { len = space; + } - uint8_t* buf = (uint8_t*)malloc(headLen); + uint8_t *buf = (uint8_t *)malloc(headLen); if (buf == NULL) { - // os_printf("could not malloc %u bytes for frame header\n", headLen); - // Serial.println("SF 3"); +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + client->abort(); return 0; } buf[0] = opcode & 0x0F; - if (final) + if (final) { buf[0] |= 0x80; - if (len < 126) + } + if (len < 126) { buf[1] = len & 0x7F; - else { + } else { buf[1] = 126; buf[2] = (uint8_t)((len >> 8) & 0xFF); buf[3] = (uint8_t)(len & 0xFF); @@ -98,7 +88,7 @@ size_t webSocketSendFrame(AsyncClient* client, bool final, uint8_t opcode, bool buf[1] |= 0x80; memcpy(buf + (headLen - 4), mbuf, 4); } - if (client->add((const char*)buf, headLen) != headLen) { + if (client->add((const char *)buf, headLen) != headLen) { // os_printf("error adding %lu header bytes\n", headLen); free(buf); // Serial.println("SF 4"); @@ -109,10 +99,11 @@ size_t webSocketSendFrame(AsyncClient* client, bool final, uint8_t opcode, bool if (len) { if (len && mask) { size_t i; - for (i = 0; i < len; i++) + for (i = 0; i < len; i++) { data[i] = data[i] ^ mbuf[i % 4]; + } } - if (client->add((const char*)data, len) != len) { + if (client->add((const char *)data, len) != len) { // os_printf("error adding %lu data bytes\n", len); // Serial.println("SF 5"); return 0; @@ -131,8 +122,7 @@ size_t webSocketSendFrame(AsyncClient* client, bool final, uint8_t opcode, bool * AsyncWebSocketMessageBuffer */ -AsyncWebSocketMessageBuffer::AsyncWebSocketMessageBuffer(const uint8_t* data, size_t size) - : _buffer(std::make_shared>(size)) { +AsyncWebSocketMessageBuffer::AsyncWebSocketMessageBuffer(const uint8_t *data, size_t size) : _buffer(std::make_shared>(size)) { if (_buffer->capacity() < size) { _buffer->reserve(size); } else { @@ -140,16 +130,16 @@ AsyncWebSocketMessageBuffer::AsyncWebSocketMessageBuffer(const uint8_t* data, si } } -AsyncWebSocketMessageBuffer::AsyncWebSocketMessageBuffer(size_t size) - : _buffer(std::make_shared>(size)) { +AsyncWebSocketMessageBuffer::AsyncWebSocketMessageBuffer(size_t size) : _buffer(std::make_shared>(size)) { if (_buffer->capacity() < size) { _buffer->reserve(size); } } bool AsyncWebSocketMessageBuffer::reserve(size_t size) { - if (_buffer->capacity() >= size) + if (_buffer->capacity() >= size) { return true; + } _buffer->reserve(size); return _buffer->capacity() >= size; } @@ -159,55 +149,66 @@ bool AsyncWebSocketMessageBuffer::reserve(size_t size) { */ class AsyncWebSocketControl { - private: - uint8_t _opcode; - uint8_t* _data; - size_t _len; - bool _mask; - bool _finished; +private: + uint8_t _opcode; + uint8_t *_data; + size_t _len; + bool _mask; + bool _finished; - public: - AsyncWebSocketControl(uint8_t opcode, const uint8_t* data = NULL, size_t len = 0, bool mask = false) - : _opcode(opcode), _len(len), _mask(len && mask), _finished(false) { - if (data == NULL) +public: + AsyncWebSocketControl(uint8_t opcode, const uint8_t *data = NULL, size_t len = 0, bool mask = false) + : _opcode(opcode), _len(len), _mask(len && mask), _finished(false) { + if (data == NULL) { + _len = 0; + } + if (_len) { + if (_len > 125) { + _len = 125; + } + + _data = (uint8_t *)malloc(_len); + + if (_data == NULL) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif _len = 0; - if (_len) { - if (_len > 125) - _len = 125; - - _data = (uint8_t*)malloc(_len); - - if (_data == NULL) - _len = 0; - else - memcpy(_data, data, len); - } else - _data = NULL; + } else { + memcpy(_data, data, len); + } + } else { + _data = NULL; } + } - ~AsyncWebSocketControl() { - if (_data != NULL) - free(_data); + ~AsyncWebSocketControl() { + if (_data != NULL) { + free(_data); } + } - bool finished() const { return _finished; } - uint8_t opcode() { return _opcode; } - uint8_t len() { return _len + 2; } - size_t send(AsyncClient* client) { - _finished = true; - return webSocketSendFrame(client, true, _opcode & 0x0F, _mask, _data, _len); - } + bool finished() const { + return _finished; + } + uint8_t opcode() { + return _opcode; + } + uint8_t len() { + return _len + 2; + } + size_t send(AsyncClient *client) { + _finished = true; + return webSocketSendFrame(client, true, _opcode & 0x0F, _mask, _data, _len); + } }; /* * AsyncWebSocketMessage Message */ -AsyncWebSocketMessage::AsyncWebSocketMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode, bool mask) : _WSbuffer{buffer}, - _opcode(opcode & 0x07), - _mask{mask}, - _status{_WSbuffer ? WS_MSG_SENDING : WS_MSG_ERROR} { -} +AsyncWebSocketMessage::AsyncWebSocketMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode, bool mask) + : _WSbuffer{buffer}, _opcode(opcode & 0x07), _mask{mask}, _status{_WSbuffer ? WS_MSG_SENDING : WS_MSG_ERROR} {} void AsyncWebSocketMessage::ack(size_t len, uint32_t time) { (void)time; @@ -218,18 +219,21 @@ void AsyncWebSocketMessage::ack(size_t len, uint32_t time) { // ets_printf("A: %u\n", len); } -size_t AsyncWebSocketMessage::send(AsyncClient* client) { - if (!client) +size_t AsyncWebSocketMessage::send(AsyncClient *client) { + if (!client) { return 0; + } - if (_status != WS_MSG_SENDING) + if (_status != WS_MSG_SENDING) { return 0; + } if (_acked < _ack) { return 0; } if (_sent == _WSbuffer->size()) { - if (_acked == _ack) + if (_acked == _ack) { _status = WS_MSG_SENT; + } return 0; } if (_sent > _WSbuffer->size()) { @@ -251,7 +255,7 @@ size_t AsyncWebSocketMessage::send(AsyncClient* client) { // ets_printf("W: %u %u\n", _sent - toSend, toSend); bool final = (_sent == _WSbuffer->size()); - uint8_t* dPtr = (uint8_t*)(_WSbuffer->data() + (_sent - toSend)); + uint8_t *dPtr = (uint8_t *)(_WSbuffer->data() + (_sent - toSend)); uint8_t opCode = (toSend && _sent == toSend) ? _opcode : (uint8_t)WS_CONTINUATION; size_t sent = webSocketSendFrame(client, final, opCode, _mask, dPtr, toSend); @@ -268,11 +272,10 @@ size_t AsyncWebSocketMessage::send(AsyncClient* client) { /* * Async WebSocket Client */ -const char* AWSC_PING_PAYLOAD = "ESPAsyncWebServer-PING"; +const char *AWSC_PING_PAYLOAD = "ESPAsyncWebServer-PING"; const size_t AWSC_PING_PAYLOAD_LEN = 22; -AsyncWebSocketClient::AsyncWebSocketClient(AsyncWebServerRequest* request, AsyncWebSocket* server) - : _tempObject(NULL) { +AsyncWebSocketClient::AsyncWebSocketClient(AsyncWebServerRequest *request, AsyncWebSocket *server) : _tempObject(NULL) { _client = request->client(); _server = server; _clientId = _server->_getNextId(); @@ -281,12 +284,48 @@ AsyncWebSocketClient::AsyncWebSocketClient(AsyncWebServerRequest* request, Async _lastMessageTime = millis(); _keepAlivePeriod = 0; _client->setRxTimeout(0); - _client->onError([](void* r, AsyncClient* c, int8_t error) { (void)c; ((AsyncWebSocketClient*)(r))->_onError(error); }, this); - _client->onAck([](void* r, AsyncClient* c, size_t len, uint32_t time) { (void)c; ((AsyncWebSocketClient*)(r))->_onAck(len, time); }, this); - _client->onDisconnect([](void* r, AsyncClient* c) { ((AsyncWebSocketClient*)(r))->_onDisconnect(); delete c; }, this); - _client->onTimeout([](void* r, AsyncClient* c, uint32_t time) { (void)c; ((AsyncWebSocketClient*)(r))->_onTimeout(time); }, this); - _client->onData([](void* r, AsyncClient* c, void* buf, size_t len) { (void)c; ((AsyncWebSocketClient*)(r))->_onData(buf, len); }, this); - _client->onPoll([](void* r, AsyncClient* c) { (void)c; ((AsyncWebSocketClient*)(r))->_onPoll(); }, this); + _client->onError( + [](void *r, AsyncClient *c, int8_t error) { + (void)c; + ((AsyncWebSocketClient *)(r))->_onError(error); + }, + this + ); + _client->onAck( + [](void *r, AsyncClient *c, size_t len, uint32_t time) { + (void)c; + ((AsyncWebSocketClient *)(r))->_onAck(len, time); + }, + this + ); + _client->onDisconnect( + [](void *r, AsyncClient *c) { + ((AsyncWebSocketClient *)(r))->_onDisconnect(); + delete c; + }, + this + ); + _client->onTimeout( + [](void *r, AsyncClient *c, uint32_t time) { + (void)c; + ((AsyncWebSocketClient *)(r))->_onTimeout(time); + }, + this + ); + _client->onData( + [](void *r, AsyncClient *c, void *buf, size_t len) { + (void)c; + ((AsyncWebSocketClient *)(r))->_onData(buf, len); + }, + this + ); + _client->onPoll( + [](void *r, AsyncClient *c) { + (void)c; + ((AsyncWebSocketClient *)(r))->_onPoll(); + }, + this + ); delete request; memset(&_pinfo, 0, sizeof(_pinfo)); } @@ -303,8 +342,9 @@ AsyncWebSocketClient::~AsyncWebSocketClient() { } void AsyncWebSocketClient::_clearQueue() { - while (!_messageQueue.empty() && _messageQueue.front().finished()) + while (!_messageQueue.empty() && _messageQueue.front().finished()) { _messageQueue.pop_front(); + } } void AsyncWebSocketClient::_onAck(size_t len, uint32_t time) { @@ -315,14 +355,15 @@ void AsyncWebSocketClient::_onAck(size_t len, uint32_t time) { #endif if (!_controlQueue.empty()) { - auto& head = _controlQueue.front(); + auto &head = _controlQueue.front(); if (head.finished()) { len -= head.len(); if (_status == WS_DISCONNECTING && head.opcode() == WS_DISCONNECT) { _controlQueue.pop_front(); _status = WS_DISCONNECTED; - if (_client) + if (_client) { _client->close(true); + } return; } _controlQueue.pop_front(); @@ -339,8 +380,9 @@ void AsyncWebSocketClient::_onAck(size_t len, uint32_t time) { } void AsyncWebSocketClient::_onPoll() { - if (!_client) + if (!_client) { return; + } #ifdef ESP32 std::unique_lock lock(_lock); @@ -351,18 +393,20 @@ void AsyncWebSocketClient::_onPoll() { #ifdef ESP32 lock.unlock(); #endif - ping((uint8_t*)AWSC_PING_PAYLOAD, AWSC_PING_PAYLOAD_LEN); + ping((uint8_t *)AWSC_PING_PAYLOAD, AWSC_PING_PAYLOAD_LEN); } } void AsyncWebSocketClient::_runQueue() { // all calls to this method MUST be protected by a mutex lock! - if (!_client) + if (!_client) { return; + } _clearQueue(); - if (!_controlQueue.empty() && (_messageQueue.empty() || _messageQueue.front().betweenFrames()) && webSocketSendFrameWindow(_client) > (size_t)(_controlQueue.front().len() - 1)) { + if (!_controlQueue.empty() && (_messageQueue.empty() || _messageQueue.front().betweenFrames()) + && webSocketSendFrameWindow(_client) > (size_t)(_controlQueue.front().len() - 1)) { _controlQueue.front().send(_client); } else if (!_messageQueue.empty() && _messageQueue.front().betweenFrames() && webSocketSendFrameWindow(_client)) { _messageQueue.front().send(_client); @@ -390,9 +434,10 @@ bool AsyncWebSocketClient::canSend() const { return _messageQueue.size() < WS_MAX_QUEUED_MESSAGES; } -bool AsyncWebSocketClient::_queueControl(uint8_t opcode, const uint8_t* data, size_t len, bool mask) { - if (!_client) +bool AsyncWebSocketClient::_queueControl(uint8_t opcode, const uint8_t *data, size_t len, bool mask) { + if (!_client) { return false; + } #ifdef ESP32 std::lock_guard lock(_lock); @@ -400,15 +445,17 @@ bool AsyncWebSocketClient::_queueControl(uint8_t opcode, const uint8_t* data, si _controlQueue.emplace_back(opcode, data, len, mask); - if (_client && _client->canSend()) + if (_client && _client->canSend()) { _runQueue(); + } return true; } bool AsyncWebSocketClient::_queueMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode, bool mask) { - if (!_client || buffer->size() == 0 || _status != WS_CONNECTED) + if (!_client || buffer->size() == 0 || _status != WS_CONNECTED) { return false; + } #ifdef ESP32 std::lock_guard lock(_lock); @@ -418,8 +465,9 @@ bool AsyncWebSocketClient::_queueMessage(AsyncWebSocketSharedBuffer buffer, uint if (closeWhenFull) { _status = WS_DISCONNECTED; - if (_client) + if (_client) { _client->close(true); + } #ifdef ESP8266 ets_printf("AsyncWebSocketClient::_queueMessage: Too many messages queued: closing connection\n"); @@ -440,15 +488,17 @@ bool AsyncWebSocketClient::_queueMessage(AsyncWebSocketSharedBuffer buffer, uint _messageQueue.emplace_back(buffer, opcode, mask); - if (_client && _client->canSend()) + if (_client && _client->canSend()) { _runQueue(); + } return true; } -void AsyncWebSocketClient::close(uint16_t code, const char* message) { - if (_status != WS_CONNECTED) +void AsyncWebSocketClient::close(uint16_t code, const char *message) { + if (_status != WS_CONNECTED) { return; + } _status = WS_DISCONNECTING; @@ -456,26 +506,32 @@ void AsyncWebSocketClient::close(uint16_t code, const char* message) { uint8_t packetLen = 2; if (message != NULL) { size_t mlen = strlen(message); - if (mlen > 123) + if (mlen > 123) { mlen = 123; + } packetLen += mlen; } - char* buf = (char*)malloc(packetLen); + char *buf = (char *)malloc(packetLen); if (buf != NULL) { buf[0] = (uint8_t)(code >> 8); buf[1] = (uint8_t)(code & 0xFF); if (message != NULL) { memcpy(buf + 2, message, packetLen - 2); } - _queueControl(WS_DISCONNECT, (uint8_t*)buf, packetLen); + _queueControl(WS_DISCONNECT, (uint8_t *)buf, packetLen); free(buf); return; + } else { +#ifdef ESP32 + log_e("Failed to allocate"); + _client->abort(); +#endif } } _queueControl(WS_DISCONNECT); } -bool AsyncWebSocketClient::ping(const uint8_t* data, size_t len) { +bool AsyncWebSocketClient::ping(const uint8_t *data, size_t len) { return _status == WS_CONNECTED && _queueControl(WS_PING, data, len); } @@ -484,8 +540,9 @@ void AsyncWebSocketClient::_onError(int8_t) { } void AsyncWebSocketClient::_onTimeout(uint32_t time) { - if (!_client) + if (!_client) { return; + } // Serial.println("onTime"); (void)time; _client->close(true); @@ -496,12 +553,12 @@ void AsyncWebSocketClient::_onDisconnect() { _client = nullptr; } -void AsyncWebSocketClient::_onData(void* pbuf, size_t plen) { +void AsyncWebSocketClient::_onData(void *pbuf, size_t plen) { _lastMessageTime = millis(); - uint8_t* data = (uint8_t*)pbuf; + uint8_t *data = (uint8_t *)pbuf; while (plen > 0) { if (!_pstate) { - const uint8_t* fdata = data; + const uint8_t *fdata = data; _pinfo.index = 0; _pinfo.final = (fdata[0] & 0x80) != 0; @@ -522,12 +579,14 @@ void AsyncWebSocketClient::_onData(void* pbuf, size_t plen) { plen -= 2; } else if (_pinfo.len == 127 && plen >= 8) { - _pinfo.len = fdata[9] | (uint16_t)(fdata[8]) << 8 | (uint32_t)(fdata[7]) << 16 | (uint32_t)(fdata[6]) << 24 | (uint64_t)(fdata[5]) << 32 | (uint64_t)(fdata[4]) << 40 | (uint64_t)(fdata[3]) << 48 | (uint64_t)(fdata[2]) << 56; + _pinfo.len = fdata[9] | (uint16_t)(fdata[8]) << 8 | (uint32_t)(fdata[7]) << 16 | (uint32_t)(fdata[6]) << 24 | (uint64_t)(fdata[5]) << 32 + | (uint64_t)(fdata[4]) << 40 | (uint64_t)(fdata[3]) << 48 | (uint64_t)(fdata[2]) << 56; data += 8; plen -= 8; } - if (_pinfo.masked && plen >= 4) { // if ws.close() is called, Safari sends a close frame with plen 2 and masked bit set. We must not decrement plen which is already 0. + if (_pinfo.masked + && plen >= 4) { // if ws.close() is called, Safari sends a close frame with plen 2 and masked bit set. We must not decrement plen which is already 0. memcpy(_pinfo.mask, data, 4); data += 4; plen -= 4; @@ -538,8 +597,9 @@ void AsyncWebSocketClient::_onData(void* pbuf, size_t plen) { const auto datalast = data[datalen]; if (_pinfo.masked) { - for (size_t i = 0; i < datalen; i++) + for (size_t i = 0; i < datalen; i++) { data[i] ^= _pinfo.mask[(_pinfo.index + i) % 4]; + } } if ((datalen + _pinfo.index) < _pinfo.len) { @@ -551,8 +611,9 @@ void AsyncWebSocketClient::_onData(void* pbuf, size_t plen) { _pinfo.num = 0; } } - if (datalen > 0) - _server->_handleEvent(this, WS_EVT_DATA, (void*)&_pinfo, data, datalen); + if (datalen > 0) { + _server->_handleEvent(this, WS_EVT_DATA, (void *)&_pinfo, data, datalen); + } _pinfo.index += datalen; } else if ((datalen + _pinfo.index) == _pinfo.len) { @@ -560,33 +621,37 @@ void AsyncWebSocketClient::_onData(void* pbuf, size_t plen) { if (_pinfo.opcode == WS_DISCONNECT) { if (datalen) { uint16_t reasonCode = (uint16_t)(data[0] << 8) + data[1]; - char* reasonString = (char*)(data + 2); + char *reasonString = (char *)(data + 2); if (reasonCode > 1001) { - _server->_handleEvent(this, WS_EVT_ERROR, (void*)&reasonCode, (uint8_t*)reasonString, strlen(reasonString)); + _server->_handleEvent(this, WS_EVT_ERROR, (void *)&reasonCode, (uint8_t *)reasonString, strlen(reasonString)); } } if (_status == WS_DISCONNECTING) { _status = WS_DISCONNECTED; - if (_client) + if (_client) { _client->close(true); + } } else { _status = WS_DISCONNECTING; - if (_client) + if (_client) { _client->ackLater(); + } _queueControl(WS_DISCONNECT, data, datalen); } } else if (_pinfo.opcode == WS_PING) { _server->_handleEvent(this, WS_EVT_PING, NULL, NULL, 0); _queueControl(WS_PONG, data, datalen); } else if (_pinfo.opcode == WS_PONG) { - if (datalen != AWSC_PING_PAYLOAD_LEN || memcmp(AWSC_PING_PAYLOAD, data, AWSC_PING_PAYLOAD_LEN) != 0) + if (datalen != AWSC_PING_PAYLOAD_LEN || memcmp(AWSC_PING_PAYLOAD, data, AWSC_PING_PAYLOAD_LEN) != 0) { _server->_handleEvent(this, WS_EVT_PONG, NULL, NULL, 0); - } else if (_pinfo.opcode < WS_DISCONNECT) { // continuation or text/binary frame - _server->_handleEvent(this, WS_EVT_DATA, (void*)&_pinfo, data, datalen); - if (_pinfo.final) + } + } else if (_pinfo.opcode < WS_DISCONNECT) { // continuation or text/binary frame + _server->_handleEvent(this, WS_EVT_DATA, (void *)&_pinfo, data, datalen); + if (_pinfo.final) { _pinfo.num = 0; - else + } else { _pinfo.num += 1; + } } } else { // os_printf("frame error: len: %u, index: %llu, total: %llu\n", datalen, _pinfo.index, _pinfo.len); @@ -595,27 +660,30 @@ void AsyncWebSocketClient::_onData(void* pbuf, size_t plen) { } // restore byte as _handleEvent may have added a null terminator i.e., data[len] = 0; - if (datalen) + if (datalen) { data[datalen] = datalast; + } data += datalen; plen -= datalen; } } -size_t AsyncWebSocketClient::printf(const char* format, ...) { +size_t AsyncWebSocketClient::printf(const char *format, ...) { va_list arg; va_start(arg, format); size_t len = vsnprintf(nullptr, 0, format, arg); va_end(arg); - if (len == 0) + if (len == 0) { return 0; + } - char* buffer = new char[len + 1]; + char *buffer = new char[len + 1]; - if (!buffer) + if (!buffer) { return 0; + } va_start(arg, format); len = vsnprintf(buffer, len + 1, format, arg); @@ -633,13 +701,15 @@ size_t AsyncWebSocketClient::printf_P(PGM_P formatP, ...) { size_t len = vsnprintf_P(nullptr, 0, formatP, arg); va_end(arg); - if (len == 0) + if (len == 0) { return 0; + } - char* buffer = new char[len + 1]; + char *buffer = new char[len + 1]; - if (!buffer) + if (!buffer) { return 0; + } va_start(arg, formatP); len = vsnprintf_P(buffer, len + 1, formatP, arg); @@ -652,14 +722,14 @@ size_t AsyncWebSocketClient::printf_P(PGM_P formatP, ...) { #endif namespace { - AsyncWebSocketSharedBuffer makeSharedBuffer(const uint8_t* message, size_t len) { - auto buffer = std::make_shared>(len); - std::memcpy(buffer->data(), message, len); - return buffer; - } +AsyncWebSocketSharedBuffer makeSharedBuffer(const uint8_t *message, size_t len) { + auto buffer = std::make_shared>(len); + std::memcpy(buffer->data(), message, len); + return buffer; } +} // namespace -bool AsyncWebSocketClient::text(AsyncWebSocketMessageBuffer* buffer) { +bool AsyncWebSocketClient::text(AsyncWebSocketMessageBuffer *buffer) { bool enqueued = false; if (buffer) { enqueued = text(std::move(buffer->_buffer)); @@ -672,34 +742,35 @@ bool AsyncWebSocketClient::text(AsyncWebSocketSharedBuffer buffer) { return _queueMessage(buffer); } -bool AsyncWebSocketClient::text(const uint8_t* message, size_t len) { +bool AsyncWebSocketClient::text(const uint8_t *message, size_t len) { return text(makeSharedBuffer(message, len)); } -bool AsyncWebSocketClient::text(const char* message, size_t len) { - return text((const uint8_t*)message, len); +bool AsyncWebSocketClient::text(const char *message, size_t len) { + return text((const uint8_t *)message, len); } -bool AsyncWebSocketClient::text(const char* message) { +bool AsyncWebSocketClient::text(const char *message) { return text(message, strlen(message)); } -bool AsyncWebSocketClient::text(const String& message) { +bool AsyncWebSocketClient::text(const String &message) { return text(message.c_str(), message.length()); } #ifdef ESP8266 -bool AsyncWebSocketClient::text(const __FlashStringHelper* data) { +bool AsyncWebSocketClient::text(const __FlashStringHelper *data) { PGM_P p = reinterpret_cast(data); size_t n = 0; while (1) { - if (pgm_read_byte(p + n) == 0) + if (pgm_read_byte(p + n) == 0) { break; + } n += 1; } - char* message = (char*)malloc(n + 1); + char *message = (char *)malloc(n + 1); bool enqueued = false; if (message) { memcpy_P(message, p, n); @@ -709,9 +780,9 @@ bool AsyncWebSocketClient::text(const __FlashStringHelper* data) { } return enqueued; } -#endif // ESP8266 +#endif // ESP8266 -bool AsyncWebSocketClient::binary(AsyncWebSocketMessageBuffer* buffer) { +bool AsyncWebSocketClient::binary(AsyncWebSocketMessageBuffer *buffer) { bool enqueued = false; if (buffer) { enqueued = binary(std::move(buffer->_buffer)); @@ -724,26 +795,26 @@ bool AsyncWebSocketClient::binary(AsyncWebSocketSharedBuffer buffer) { return _queueMessage(buffer, WS_BINARY); } -bool AsyncWebSocketClient::binary(const uint8_t* message, size_t len) { +bool AsyncWebSocketClient::binary(const uint8_t *message, size_t len) { return binary(makeSharedBuffer(message, len)); } -bool AsyncWebSocketClient::binary(const char* message, size_t len) { - return binary((const uint8_t*)message, len); +bool AsyncWebSocketClient::binary(const char *message, size_t len) { + return binary((const uint8_t *)message, len); } -bool AsyncWebSocketClient::binary(const char* message) { +bool AsyncWebSocketClient::binary(const char *message) { return binary(message, strlen(message)); } -bool AsyncWebSocketClient::binary(const String& message) { +bool AsyncWebSocketClient::binary(const String &message) { return binary(message.c_str(), message.length()); } #ifdef ESP8266 -bool AsyncWebSocketClient::binary(const __FlashStringHelper* data, size_t len) { +bool AsyncWebSocketClient::binary(const __FlashStringHelper *data, size_t len) { PGM_P p = reinterpret_cast(data); - char* message = (char*)malloc(len); + char *message = (char *)malloc(len); bool enqueued = false; if (message) { memcpy_P(message, p, len); @@ -755,15 +826,17 @@ bool AsyncWebSocketClient::binary(const __FlashStringHelper* data, size_t len) { #endif IPAddress AsyncWebSocketClient::remoteIP() const { - if (!_client) + if (!_client) { return IPAddress((uint32_t)0U); + } return _client->remoteIP(); } uint16_t AsyncWebSocketClient::remotePort() const { - if (!_client) + if (!_client) { return 0; + } return _client->remotePort(); } @@ -772,106 +845,123 @@ uint16_t AsyncWebSocketClient::remotePort() const { * Async Web Socket - Each separate socket location */ -void AsyncWebSocket::_handleEvent(AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len) { +void AsyncWebSocket::_handleEvent(AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len) { if (_eventHandler != NULL) { _eventHandler(this, client, type, arg, data, len); } } -AsyncWebSocketClient* AsyncWebSocket::_newClient(AsyncWebServerRequest* request) { +AsyncWebSocketClient *AsyncWebSocket::_newClient(AsyncWebServerRequest *request) { _clients.emplace_back(request, this); _handleEvent(&_clients.back(), WS_EVT_CONNECT, request, NULL, 0); return &_clients.back(); } bool AsyncWebSocket::availableForWriteAll() { - return std::none_of(std::begin(_clients), std::end(_clients), [](const AsyncWebSocketClient& c) { return c.queueIsFull(); }); + return std::none_of(std::begin(_clients), std::end(_clients), [](const AsyncWebSocketClient &c) { + return c.queueIsFull(); + }); } bool AsyncWebSocket::availableForWrite(uint32_t id) { - const auto iter = std::find_if(std::begin(_clients), std::end(_clients), [id](const AsyncWebSocketClient& c) { return c.id() == id; }); - if (iter == std::end(_clients)) + const auto iter = std::find_if(std::begin(_clients), std::end(_clients), [id](const AsyncWebSocketClient &c) { + return c.id() == id; + }); + if (iter == std::end(_clients)) { return true; + } return !iter->queueIsFull(); } size_t AsyncWebSocket::count() const { - return std::count_if(std::begin(_clients), std::end(_clients), [](const AsyncWebSocketClient& c) { return c.status() == WS_CONNECTED; }); + return std::count_if(std::begin(_clients), std::end(_clients), [](const AsyncWebSocketClient &c) { + return c.status() == WS_CONNECTED; + }); } -AsyncWebSocketClient* AsyncWebSocket::client(uint32_t id) { - const auto iter = std::find_if(_clients.begin(), _clients.end(), [id](const AsyncWebSocketClient& c) { return c.id() == id && c.status() == WS_CONNECTED; }); - if (iter == std::end(_clients)) +AsyncWebSocketClient *AsyncWebSocket::client(uint32_t id) { + const auto iter = std::find_if(_clients.begin(), _clients.end(), [id](const AsyncWebSocketClient &c) { + return c.id() == id && c.status() == WS_CONNECTED; + }); + if (iter == std::end(_clients)) { return nullptr; + } return &(*iter); } -void AsyncWebSocket::close(uint32_t id, uint16_t code, const char* message) { - if (AsyncWebSocketClient* c = client(id)) +void AsyncWebSocket::close(uint32_t id, uint16_t code, const char *message) { + if (AsyncWebSocketClient *c = client(id)) { c->close(code, message); -} - -void AsyncWebSocket::closeAll(uint16_t code, const char* message) { - for (auto& c : _clients) - if (c.status() == WS_CONNECTED) - c.close(code, message); -} - -void AsyncWebSocket::cleanupClients(uint16_t maxClients) { - if (count() > maxClients) - _clients.front().close(); - - for (auto iter = std::begin(_clients); iter != std::end(_clients);) { - if (iter->shouldBeDeleted()) - iter = _clients.erase(iter); - else - iter++; } } -bool AsyncWebSocket::ping(uint32_t id, const uint8_t* data, size_t len) { - AsyncWebSocketClient* c = client(id); +void AsyncWebSocket::closeAll(uint16_t code, const char *message) { + for (auto &c : _clients) { + if (c.status() == WS_CONNECTED) { + c.close(code, message); + } + } +} + +void AsyncWebSocket::cleanupClients(uint16_t maxClients) { + if (count() > maxClients) { + _clients.front().close(); + } + + for (auto i = _clients.begin(); i != _clients.end(); ++i) { + if (i->shouldBeDeleted()) { + _clients.erase(i); + break; + } + } +} + +bool AsyncWebSocket::ping(uint32_t id, const uint8_t *data, size_t len) { + AsyncWebSocketClient *c = client(id); return c && c->ping(data, len); } -AsyncWebSocket::SendStatus AsyncWebSocket::pingAll(const uint8_t* data, size_t len) { +AsyncWebSocket::SendStatus AsyncWebSocket::pingAll(const uint8_t *data, size_t len) { size_t hit = 0; size_t miss = 0; - for (auto& c : _clients) - if (c.status() == WS_CONNECTED && c.ping(data, len)) + for (auto &c : _clients) { + if (c.status() == WS_CONNECTED && c.ping(data, len)) { hit++; - else + } else { miss++; + } + } return hit == 0 ? DISCARDED : (miss == 0 ? ENQUEUED : PARTIALLY_ENQUEUED); } -bool AsyncWebSocket::text(uint32_t id, const uint8_t* message, size_t len) { - AsyncWebSocketClient* c = client(id); +bool AsyncWebSocket::text(uint32_t id, const uint8_t *message, size_t len) { + AsyncWebSocketClient *c = client(id); return c && c->text(makeSharedBuffer(message, len)); } -bool AsyncWebSocket::text(uint32_t id, const char* message, size_t len) { - return text(id, (const uint8_t*)message, len); +bool AsyncWebSocket::text(uint32_t id, const char *message, size_t len) { + return text(id, (const uint8_t *)message, len); } -bool AsyncWebSocket::text(uint32_t id, const char* message) { +bool AsyncWebSocket::text(uint32_t id, const char *message) { return text(id, message, strlen(message)); } -bool AsyncWebSocket::text(uint32_t id, const String& message) { +bool AsyncWebSocket::text(uint32_t id, const String &message) { return text(id, message.c_str(), message.length()); } #ifdef ESP8266 -bool AsyncWebSocket::text(uint32_t id, const __FlashStringHelper* data) { +bool AsyncWebSocket::text(uint32_t id, const __FlashStringHelper *data) { PGM_P p = reinterpret_cast(data); size_t n = 0; while (true) { - if (pgm_read_byte(p + n) == 0) + if (pgm_read_byte(p + n) == 0) { break; + } n += 1; } - char* message = (char*)malloc(n + 1); + char *message = (char *)malloc(n + 1); bool enqueued = false; if (message) { memcpy_P(message, p, n); @@ -881,9 +971,9 @@ bool AsyncWebSocket::text(uint32_t id, const __FlashStringHelper* data) { } return enqueued; } -#endif // ESP8266 +#endif // ESP8266 -bool AsyncWebSocket::text(uint32_t id, AsyncWebSocketMessageBuffer* buffer) { +bool AsyncWebSocket::text(uint32_t id, AsyncWebSocketMessageBuffer *buffer) { bool enqueued = false; if (buffer) { enqueued = text(id, std::move(buffer->_buffer)); @@ -892,34 +982,35 @@ bool AsyncWebSocket::text(uint32_t id, AsyncWebSocketMessageBuffer* buffer) { return enqueued; } bool AsyncWebSocket::text(uint32_t id, AsyncWebSocketSharedBuffer buffer) { - AsyncWebSocketClient* c = client(id); + AsyncWebSocketClient *c = client(id); return c && c->text(buffer); } -AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const uint8_t* message, size_t len) { +AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const uint8_t *message, size_t len) { return textAll(makeSharedBuffer(message, len)); } -AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const char* message, size_t len) { - return textAll((const uint8_t*)message, len); +AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const char *message, size_t len) { + return textAll((const uint8_t *)message, len); } -AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const char* message) { +AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const char *message) { return textAll(message, strlen(message)); } -AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const String& message) { +AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const String &message) { return textAll(message.c_str(), message.length()); } #ifdef ESP8266 -AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const __FlashStringHelper* data) { +AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const __FlashStringHelper *data) { PGM_P p = reinterpret_cast(data); size_t n = 0; while (1) { - if (pgm_read_byte(p + n) == 0) + if (pgm_read_byte(p + n) == 0) { break; + } n += 1; } - char* message = (char*)malloc(n + 1); + char *message = (char *)malloc(n + 1); AsyncWebSocket::SendStatus status = DISCARDED; if (message) { memcpy_P(message, p, n); @@ -929,8 +1020,8 @@ AsyncWebSocket::SendStatus AsyncWebSocket::textAll(const __FlashStringHelper* da } return status; } -#endif // ESP8266 -AsyncWebSocket::SendStatus AsyncWebSocket::textAll(AsyncWebSocketMessageBuffer* buffer) { +#endif // ESP8266 +AsyncWebSocket::SendStatus AsyncWebSocket::textAll(AsyncWebSocketMessageBuffer *buffer) { AsyncWebSocket::SendStatus status = DISCARDED; if (buffer) { status = textAll(std::move(buffer->_buffer)); @@ -942,32 +1033,34 @@ AsyncWebSocket::SendStatus AsyncWebSocket::textAll(AsyncWebSocketMessageBuffer* AsyncWebSocket::SendStatus AsyncWebSocket::textAll(AsyncWebSocketSharedBuffer buffer) { size_t hit = 0; size_t miss = 0; - for (auto& c : _clients) - if (c.status() == WS_CONNECTED && c.text(buffer)) + for (auto &c : _clients) { + if (c.status() == WS_CONNECTED && c.text(buffer)) { hit++; - else + } else { miss++; + } + } return hit == 0 ? DISCARDED : (miss == 0 ? ENQUEUED : PARTIALLY_ENQUEUED); } -bool AsyncWebSocket::binary(uint32_t id, const uint8_t* message, size_t len) { - AsyncWebSocketClient* c = client(id); +bool AsyncWebSocket::binary(uint32_t id, const uint8_t *message, size_t len) { + AsyncWebSocketClient *c = client(id); return c && c->binary(makeSharedBuffer(message, len)); } -bool AsyncWebSocket::binary(uint32_t id, const char* message, size_t len) { - return binary(id, (const uint8_t*)message, len); +bool AsyncWebSocket::binary(uint32_t id, const char *message, size_t len) { + return binary(id, (const uint8_t *)message, len); } -bool AsyncWebSocket::binary(uint32_t id, const char* message) { +bool AsyncWebSocket::binary(uint32_t id, const char *message) { return binary(id, message, strlen(message)); } -bool AsyncWebSocket::binary(uint32_t id, const String& message) { +bool AsyncWebSocket::binary(uint32_t id, const String &message) { return binary(id, message.c_str(), message.length()); } #ifdef ESP8266 -bool AsyncWebSocket::binary(uint32_t id, const __FlashStringHelper* data, size_t len) { +bool AsyncWebSocket::binary(uint32_t id, const __FlashStringHelper *data, size_t len) { PGM_P p = reinterpret_cast(data); - char* message = (char*)malloc(len); + char *message = (char *)malloc(len); bool enqueued = false; if (message) { memcpy_P(message, p, len); @@ -976,9 +1069,9 @@ bool AsyncWebSocket::binary(uint32_t id, const __FlashStringHelper* data, size_t } return enqueued; } -#endif // ESP8266 +#endif // ESP8266 -bool AsyncWebSocket::binary(uint32_t id, AsyncWebSocketMessageBuffer* buffer) { +bool AsyncWebSocket::binary(uint32_t id, AsyncWebSocketMessageBuffer *buffer) { bool enqueued = false; if (buffer) { enqueued = binary(id, std::move(buffer->_buffer)); @@ -987,27 +1080,27 @@ bool AsyncWebSocket::binary(uint32_t id, AsyncWebSocketMessageBuffer* buffer) { return enqueued; } bool AsyncWebSocket::binary(uint32_t id, AsyncWebSocketSharedBuffer buffer) { - AsyncWebSocketClient* c = client(id); + AsyncWebSocketClient *c = client(id); return c && c->binary(buffer); } -AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const uint8_t* message, size_t len) { +AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const uint8_t *message, size_t len) { return binaryAll(makeSharedBuffer(message, len)); } -AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const char* message, size_t len) { - return binaryAll((const uint8_t*)message, len); +AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const char *message, size_t len) { + return binaryAll((const uint8_t *)message, len); } -AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const char* message) { +AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const char *message) { return binaryAll(message, strlen(message)); } -AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const String& message) { +AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const String &message) { return binaryAll(message.c_str(), message.length()); } #ifdef ESP8266 -AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const __FlashStringHelper* data, size_t len) { +AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const __FlashStringHelper *data, size_t len) { PGM_P p = reinterpret_cast(data); - char* message = (char*)malloc(len); + char *message = (char *)malloc(len); AsyncWebSocket::SendStatus status = DISCARDED; if (message) { memcpy_P(message, p, len); @@ -1016,9 +1109,9 @@ AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(const __FlashStringHelper* } return status; } -#endif // ESP8266 +#endif // ESP8266 -AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(AsyncWebSocketMessageBuffer* buffer) { +AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(AsyncWebSocketMessageBuffer *buffer) { AsyncWebSocket::SendStatus status = DISCARDED; if (buffer) { status = binaryAll(std::move(buffer->_buffer)); @@ -1029,16 +1122,18 @@ AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(AsyncWebSocketMessageBuffer AsyncWebSocket::SendStatus AsyncWebSocket::binaryAll(AsyncWebSocketSharedBuffer buffer) { size_t hit = 0; size_t miss = 0; - for (auto& c : _clients) - if (c.status() == WS_CONNECTED && c.binary(buffer)) + for (auto &c : _clients) { + if (c.status() == WS_CONNECTED && c.binary(buffer)) { hit++; - else + } else { miss++; + } + } return hit == 0 ? DISCARDED : (miss == 0 ? ENQUEUED : PARTIALLY_ENQUEUED); } -size_t AsyncWebSocket::printf(uint32_t id, const char* format, ...) { - AsyncWebSocketClient* c = client(id); +size_t AsyncWebSocket::printf(uint32_t id, const char *format, ...) { + AsyncWebSocketClient *c = client(id); if (c) { va_list arg; va_start(arg, format); @@ -1049,19 +1144,21 @@ size_t AsyncWebSocket::printf(uint32_t id, const char* format, ...) { return 0; } -size_t AsyncWebSocket::printfAll(const char* format, ...) { +size_t AsyncWebSocket::printfAll(const char *format, ...) { va_list arg; va_start(arg, format); size_t len = vsnprintf(nullptr, 0, format, arg); va_end(arg); - if (len == 0) + if (len == 0) { return 0; + } - char* buffer = new char[len + 1]; + char *buffer = new char[len + 1]; - if (!buffer) + if (!buffer) { return 0; + } va_start(arg, format); len = vsnprintf(buffer, len + 1, format, arg); @@ -1074,7 +1171,7 @@ size_t AsyncWebSocket::printfAll(const char* format, ...) { #ifdef ESP8266 size_t AsyncWebSocket::printf_P(uint32_t id, PGM_P formatP, ...) { - AsyncWebSocketClient* c = client(id); + AsyncWebSocketClient *c = client(id); if (c != NULL) { va_list arg; va_start(arg, formatP); @@ -1091,13 +1188,15 @@ size_t AsyncWebSocket::printfAll_P(PGM_P formatP, ...) { size_t len = vsnprintf_P(nullptr, 0, formatP, arg); va_end(arg); - if (len == 0) + if (len == 0) { return 0; + } - char* buffer = new char[len + 1]; + char *buffer = new char[len + 1]; - if (!buffer) + if (!buffer) { return 0; + } va_start(arg, formatP); len = vsnprintf_P(buffer, len + 1, formatP, arg); @@ -1131,11 +1230,11 @@ const char __WS_STR_UUID[] PROGMEM = {"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"}; #define WS_STR_ACCEPT FPSTR(__WS_STR_ACCEPT) #define WS_STR_UUID FPSTR(__WS_STR_UUID) -bool AsyncWebSocket::canHandle(AsyncWebServerRequest* request) const { +bool AsyncWebSocket::canHandle(AsyncWebServerRequest *request) const { return _enabled && request->isWebSocketUpgrade() && request->url().equals(_url); } -void AsyncWebSocket::handleRequest(AsyncWebServerRequest* request) { +void AsyncWebSocket::handleRequest(AsyncWebServerRequest *request) { if (!request->hasHeader(WS_STR_VERSION) || !request->hasHeader(WS_STR_KEY)) { request->send(400); return; @@ -1146,41 +1245,36 @@ void AsyncWebSocket::handleRequest(AsyncWebServerRequest* request) { return; } } - const AsyncWebHeader* version = request->getHeader(WS_STR_VERSION); + const AsyncWebHeader *version = request->getHeader(WS_STR_VERSION); if (version->value().toInt() != 13) { - AsyncWebServerResponse* response = request->beginResponse(400); + AsyncWebServerResponse *response = request->beginResponse(400); response->addHeader(WS_STR_VERSION, T_13); request->send(response); return; } - const AsyncWebHeader* key = request->getHeader(WS_STR_KEY); - AsyncWebServerResponse* response = new AsyncWebSocketResponse(key->value(), this); + const AsyncWebHeader *key = request->getHeader(WS_STR_KEY); + AsyncWebServerResponse *response = new AsyncWebSocketResponse(key->value(), this); + if (response == NULL) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + request->abort(); + return; + } if (request->hasHeader(WS_STR_PROTOCOL)) { - const AsyncWebHeader* protocol = request->getHeader(WS_STR_PROTOCOL); + const AsyncWebHeader *protocol = request->getHeader(WS_STR_PROTOCOL); // ToDo: check protocol response->addHeader(WS_STR_PROTOCOL, protocol->value()); } request->send(response); } -AsyncWebSocketMessageBuffer* AsyncWebSocket::makeBuffer(size_t size) { - AsyncWebSocketMessageBuffer* buffer = new AsyncWebSocketMessageBuffer(size); - if (buffer->length() != size) { - delete buffer; - return nullptr; - } else { - return buffer; - } +AsyncWebSocketMessageBuffer *AsyncWebSocket::makeBuffer(size_t size) { + return new AsyncWebSocketMessageBuffer(size); } -AsyncWebSocketMessageBuffer* AsyncWebSocket::makeBuffer(const uint8_t* data, size_t size) { - AsyncWebSocketMessageBuffer* buffer = new AsyncWebSocketMessageBuffer(data, size); - if (buffer->length() != size) { - delete buffer; - return nullptr; - } else { - return buffer; - } +AsyncWebSocketMessageBuffer *AsyncWebSocket::makeBuffer(const uint8_t *data, size_t size) { + return new AsyncWebSocketMessageBuffer(data, size); } /* @@ -1188,7 +1282,7 @@ AsyncWebSocketMessageBuffer* AsyncWebSocket::makeBuffer(const uint8_t* data, siz * Authentication code from https://github.com/Links2004/arduinoWebSockets/blob/master/src/WebSockets.cpp#L480 */ -AsyncWebSocketResponse::AsyncWebSocketResponse(const String& key, AsyncWebSocket* server) { +AsyncWebSocketResponse::AsyncWebSocketResponse(const String &key, AsyncWebSocket *server) { _server = server; _code = 101; _sendContentLength = false; @@ -1196,29 +1290,32 @@ AsyncWebSocketResponse::AsyncWebSocketResponse(const String& key, AsyncWebSocket uint8_t hash[20]; char buffer[33]; -#if defined(ESP8266) || defined(TARGET_RP2040) +#if defined(ESP8266) || defined(TARGET_RP2040) || defined(PICO_RP2040) || defined(PICO_RP2350) || defined(TARGET_RP2350) sha1(key + WS_STR_UUID, hash); #else String k; - k.reserve(key.length() + WS_STR_UUID_LEN); + if (!k.reserve(key.length() + WS_STR_UUID_LEN)) { + log_e("Failed to allocate"); + return; + } k.concat(key); k.concat(WS_STR_UUID); SHA1Builder sha1; sha1.begin(); - sha1.add((const uint8_t*)k.c_str(), k.length()); + sha1.add((const uint8_t *)k.c_str(), k.length()); sha1.calculate(); sha1.getBytes(hash); #endif base64_encodestate _state; base64_init_encodestate(&_state); - int len = base64_encode_block((const char*)hash, 20, buffer, &_state); + int len = base64_encode_block((const char *)hash, 20, buffer, &_state); len = base64_encode_blockend((buffer + len), &_state); addHeader(WS_STR_CONNECTION, WS_STR_UPGRADE); addHeader(WS_STR_UPGRADE, T_WS); addHeader(WS_STR_ACCEPT, buffer); } -void AsyncWebSocketResponse::_respond(AsyncWebServerRequest* request) { +void AsyncWebSocketResponse::_respond(AsyncWebServerRequest *request) { if (_state == RESPONSE_FAILED) { request->client()->close(true); return; @@ -1229,11 +1326,12 @@ void AsyncWebSocketResponse::_respond(AsyncWebServerRequest* request) { _state = RESPONSE_WAIT_ACK; } -size_t AsyncWebSocketResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time) { +size_t AsyncWebSocketResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time) { (void)time; - if (len) + if (len) { _server->_newClient(request); + } return 0; } diff --git a/src/AsyncWebSocket.h b/src/AsyncWebSocket.h index 671c866..1963e75 100644 --- a/src/AsyncWebSocket.h +++ b/src/AsyncWebSocket.h @@ -1,43 +1,26 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #ifndef ASYNCWEBSOCKET_H_ #define ASYNCWEBSOCKET_H_ #include #ifdef ESP32 - #include - #include - #ifndef WS_MAX_QUEUED_MESSAGES - #define WS_MAX_QUEUED_MESSAGES 32 - #endif +#include +#include +#ifndef WS_MAX_QUEUED_MESSAGES +#define WS_MAX_QUEUED_MESSAGES 32 +#endif #elif defined(ESP8266) - #include - #ifndef WS_MAX_QUEUED_MESSAGES - #define WS_MAX_QUEUED_MESSAGES 8 - #endif -#elif defined(TARGET_RP2040) - #include - #ifndef WS_MAX_QUEUED_MESSAGES - #define WS_MAX_QUEUED_MESSAGES 32 - #endif +#include +#ifndef WS_MAX_QUEUED_MESSAGES +#define WS_MAX_QUEUED_MESSAGES 8 +#endif +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#ifndef WS_MAX_QUEUED_MESSAGES +#define WS_MAX_QUEUED_MESSAGES 32 +#endif #endif #include @@ -45,18 +28,18 @@ #include #ifdef ESP8266 - #include - #ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library - #include <../src/Hash.h> - #endif +#include +#ifdef CRYPTO_HASH_h // include Hash.h from espressif framework if the first include was from the crypto library +#include <../src/Hash.h> +#endif #endif #ifndef DEFAULT_MAX_WS_CLIENTS - #ifdef ESP32 - #define DEFAULT_MAX_WS_CLIENTS 8 - #else - #define DEFAULT_MAX_WS_CLIENTS 4 - #endif +#ifdef ESP32 +#define DEFAULT_MAX_WS_CLIENTS 8 +#else +#define DEFAULT_MAX_WS_CLIENTS 4 +#endif #endif using AsyncWebSocketSharedBuffer = std::shared_ptr>; @@ -67,311 +50,367 @@ class AsyncWebSocketClient; class AsyncWebSocketControl; typedef struct { - /** Message type as defined by enum AwsFrameType. + /** Message type as defined by enum AwsFrameType. * Note: Applications will only see WS_TEXT and WS_BINARY. * All other types are handled by the library. */ - uint8_t message_opcode; - /** Frame number of a fragmented message. */ - uint32_t num; - /** Is this the last frame in a fragmented message ?*/ - uint8_t final; - /** Is this frame masked? */ - uint8_t masked; - /** Message type as defined by enum AwsFrameType. + uint8_t message_opcode; + /** Frame number of a fragmented message. */ + uint32_t num; + /** Is this the last frame in a fragmented message ?*/ + uint8_t final; + /** Is this frame masked? */ + uint8_t masked; + /** Message type as defined by enum AwsFrameType. * This value is the same as message_opcode for non-fragmented * messages, but may also be WS_CONTINUATION in a fragmented message. */ - uint8_t opcode; - /** Length of the current frame. + uint8_t opcode; + /** Length of the current frame. * This equals the total length of the message if num == 0 && final == true */ - uint64_t len; - /** Mask key */ - uint8_t mask[4]; - /** Offset of the data inside the current frame. */ - uint64_t index; + uint64_t len; + /** Mask key */ + uint8_t mask[4]; + /** Offset of the data inside the current frame. */ + uint64_t index; } AwsFrameInfo; -typedef enum { WS_DISCONNECTED, - WS_CONNECTED, - WS_DISCONNECTING } AwsClientStatus; -typedef enum { WS_CONTINUATION, - WS_TEXT, - WS_BINARY, - WS_DISCONNECT = 0x08, - WS_PING, - WS_PONG } AwsFrameType; -typedef enum { WS_MSG_SENDING, - WS_MSG_SENT, - WS_MSG_ERROR } AwsMessageStatus; -typedef enum { WS_EVT_CONNECT, - WS_EVT_DISCONNECT, - WS_EVT_PING, - WS_EVT_PONG, - WS_EVT_ERROR, - WS_EVT_DATA } AwsEventType; +typedef enum { + WS_DISCONNECTED, + WS_CONNECTED, + WS_DISCONNECTING +} AwsClientStatus; +typedef enum { + WS_CONTINUATION, + WS_TEXT, + WS_BINARY, + WS_DISCONNECT = 0x08, + WS_PING, + WS_PONG +} AwsFrameType; +typedef enum { + WS_MSG_SENDING, + WS_MSG_SENT, + WS_MSG_ERROR +} AwsMessageStatus; +typedef enum { + WS_EVT_CONNECT, + WS_EVT_DISCONNECT, + WS_EVT_PING, + WS_EVT_PONG, + WS_EVT_ERROR, + WS_EVT_DATA +} AwsEventType; class AsyncWebSocketMessageBuffer { - friend AsyncWebSocket; - friend AsyncWebSocketClient; + friend AsyncWebSocket; + friend AsyncWebSocketClient; - private: - AsyncWebSocketSharedBuffer _buffer; +private: + AsyncWebSocketSharedBuffer _buffer; - public: - AsyncWebSocketMessageBuffer() {} - explicit AsyncWebSocketMessageBuffer(size_t size); - AsyncWebSocketMessageBuffer(const uint8_t* data, size_t size); - //~AsyncWebSocketMessageBuffer(); - bool reserve(size_t size); - uint8_t* get() { return _buffer->data(); } - size_t length() const { return _buffer->size(); } +public: + AsyncWebSocketMessageBuffer() {} + explicit AsyncWebSocketMessageBuffer(size_t size); + AsyncWebSocketMessageBuffer(const uint8_t *data, size_t size); + //~AsyncWebSocketMessageBuffer(); + bool reserve(size_t size); + uint8_t *get() { + return _buffer->data(); + } + size_t length() const { + return _buffer->size(); + } }; class AsyncWebSocketMessage { - private: - AsyncWebSocketSharedBuffer _WSbuffer; - uint8_t _opcode{WS_TEXT}; - bool _mask{false}; - AwsMessageStatus _status{WS_MSG_ERROR}; - size_t _sent{}; - size_t _ack{}; - size_t _acked{}; +private: + AsyncWebSocketSharedBuffer _WSbuffer; + uint8_t _opcode{WS_TEXT}; + bool _mask{false}; + AwsMessageStatus _status{WS_MSG_ERROR}; + size_t _sent{}; + size_t _ack{}; + size_t _acked{}; - public: - AsyncWebSocketMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false); +public: + AsyncWebSocketMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false); - bool finished() const { return _status != WS_MSG_SENDING; } - bool betweenFrames() const { return _acked == _ack; } + bool finished() const { + return _status != WS_MSG_SENDING; + } + bool betweenFrames() const { + return _acked == _ack; + } - void ack(size_t len, uint32_t time); - size_t send(AsyncClient* client); + void ack(size_t len, uint32_t time); + size_t send(AsyncClient *client); }; class AsyncWebSocketClient { - private: - AsyncClient* _client; - AsyncWebSocket* _server; - uint32_t _clientId; - AwsClientStatus _status; +private: + AsyncClient *_client; + AsyncWebSocket *_server; + uint32_t _clientId; + AwsClientStatus _status; #ifdef ESP32 - mutable std::mutex _lock; + mutable std::mutex _lock; #endif - std::deque _controlQueue; - std::deque _messageQueue; - bool closeWhenFull = true; + std::deque _controlQueue; + std::deque _messageQueue; + bool closeWhenFull = true; - uint8_t _pstate; - AwsFrameInfo _pinfo; + uint8_t _pstate; + AwsFrameInfo _pinfo; - uint32_t _lastMessageTime; - uint32_t _keepAlivePeriod; + uint32_t _lastMessageTime; + uint32_t _keepAlivePeriod; - bool _queueControl(uint8_t opcode, const uint8_t* data = NULL, size_t len = 0, bool mask = false); - bool _queueMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false); - void _runQueue(); - void _clearQueue(); + bool _queueControl(uint8_t opcode, const uint8_t *data = NULL, size_t len = 0, bool mask = false); + bool _queueMessage(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false); + void _runQueue(); + void _clearQueue(); - public: - void* _tempObject; +public: + void *_tempObject; - AsyncWebSocketClient(AsyncWebServerRequest* request, AsyncWebSocket* server); - ~AsyncWebSocketClient(); + AsyncWebSocketClient(AsyncWebServerRequest *request, AsyncWebSocket *server); + ~AsyncWebSocketClient(); - // client id increments for the given server - uint32_t id() const { return _clientId; } - AwsClientStatus status() const { return _status; } - AsyncClient* client() { return _client; } - const AsyncClient* client() const { return _client; } - AsyncWebSocket* server() { return _server; } - const AsyncWebSocket* server() const { return _server; } - AwsFrameInfo const& pinfo() const { return _pinfo; } + // client id increments for the given server + uint32_t id() const { + return _clientId; + } + AwsClientStatus status() const { + return _status; + } + AsyncClient *client() { + return _client; + } + const AsyncClient *client() const { + return _client; + } + AsyncWebSocket *server() { + return _server; + } + const AsyncWebSocket *server() const { + return _server; + } + AwsFrameInfo const &pinfo() const { + return _pinfo; + } - // - If "true" (default), the connection will be closed if the message queue is full. - // This is the default behavior in yubox-node-org, which is not silently discarding messages but instead closes the connection. - // The big issue with this behavior is that is can cause the UI to automatically re-create a new WS connection, which can be filled again, - // and so on, causing a resource exhaustion. - // - // - If "false", the incoming message will be discarded if the queue is full. - // This is the default behavior in the original ESPAsyncWebServer library from me-no-dev. - // This behavior allows the best performance at the expense of unreliable message delivery in case the queue is full (some messages may be lost). - // - // - In any case, when the queue is full, a message is logged. - // - IT is recommended to use the methods queueIsFull(), availableForWriteAll(), availableForWrite(clientId) to check if the queue is full before sending a message. - // - // Usage: - // - can be set in the onEvent listener when connecting (event type is: WS_EVT_CONNECT) - // - // Use cases:, - // - if using websocket to send logging messages, maybe some loss is acceptable. - // - But if using websocket to send UI update messages, maybe the connection should be closed and the UI redrawn. - void setCloseClientOnQueueFull(bool close) { closeWhenFull = close; } - bool willCloseClientOnQueueFull() const { return closeWhenFull; } + // - If "true" (default), the connection will be closed if the message queue is full. + // This is the default behavior in yubox-node-org, which is not silently discarding messages but instead closes the connection. + // The big issue with this behavior is that is can cause the UI to automatically re-create a new WS connection, which can be filled again, + // and so on, causing a resource exhaustion. + // + // - If "false", the incoming message will be discarded if the queue is full. + // This is the default behavior in the original ESPAsyncWebServer library from me-no-dev. + // This behavior allows the best performance at the expense of unreliable message delivery in case the queue is full (some messages may be lost). + // + // - In any case, when the queue is full, a message is logged. + // - IT is recommended to use the methods queueIsFull(), availableForWriteAll(), availableForWrite(clientId) to check if the queue is full before sending a message. + // + // Usage: + // - can be set in the onEvent listener when connecting (event type is: WS_EVT_CONNECT) + // + // Use cases:, + // - if using websocket to send logging messages, maybe some loss is acceptable. + // - But if using websocket to send UI update messages, maybe the connection should be closed and the UI redrawn. + void setCloseClientOnQueueFull(bool close) { + closeWhenFull = close; + } + bool willCloseClientOnQueueFull() const { + return closeWhenFull; + } - IPAddress remoteIP() const; - uint16_t remotePort() const; + IPAddress remoteIP() const; + uint16_t remotePort() const; - bool shouldBeDeleted() const { return !_client; } + bool shouldBeDeleted() const { + return !_client; + } - // control frames - void close(uint16_t code = 0, const char* message = NULL); - bool ping(const uint8_t* data = NULL, size_t len = 0); + // control frames + void close(uint16_t code = 0, const char *message = NULL); + bool ping(const uint8_t *data = NULL, size_t len = 0); - // set auto-ping period in seconds. disabled if zero (default) - void keepAlivePeriod(uint16_t seconds) { - _keepAlivePeriod = seconds * 1000; - } - uint16_t keepAlivePeriod() { - return (uint16_t)(_keepAlivePeriod / 1000); - } + // set auto-ping period in seconds. disabled if zero (default) + void keepAlivePeriod(uint16_t seconds) { + _keepAlivePeriod = seconds * 1000; + } + uint16_t keepAlivePeriod() { + return (uint16_t)(_keepAlivePeriod / 1000); + } - // data packets - void message(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false) { _queueMessage(buffer, opcode, mask); } - bool queueIsFull() const; - size_t queueLen() const; + // data packets + void message(AsyncWebSocketSharedBuffer buffer, uint8_t opcode = WS_TEXT, bool mask = false) { + _queueMessage(buffer, opcode, mask); + } + bool queueIsFull() const; + size_t queueLen() const; - size_t printf(const char* format, ...) __attribute__((format(printf, 2, 3))); + size_t printf(const char *format, ...) __attribute__((format(printf, 2, 3))); - bool text(AsyncWebSocketSharedBuffer buffer); - bool text(const uint8_t* message, size_t len); - bool text(const char* message, size_t len); - bool text(const char* message); - bool text(const String& message); - bool text(AsyncWebSocketMessageBuffer* buffer); + bool text(AsyncWebSocketSharedBuffer buffer); + bool text(const uint8_t *message, size_t len); + bool text(const char *message, size_t len); + bool text(const char *message); + bool text(const String &message); + bool text(AsyncWebSocketMessageBuffer *buffer); - bool binary(AsyncWebSocketSharedBuffer buffer); - bool binary(const uint8_t* message, size_t len); - bool binary(const char* message, size_t len); - bool binary(const char* message); - bool binary(const String& message); - bool binary(AsyncWebSocketMessageBuffer* buffer); + bool binary(AsyncWebSocketSharedBuffer buffer); + bool binary(const uint8_t *message, size_t len); + bool binary(const char *message, size_t len); + bool binary(const char *message); + bool binary(const String &message); + bool binary(AsyncWebSocketMessageBuffer *buffer); - bool canSend() const; + bool canSend() const; - // system callbacks (do not call) - void _onAck(size_t len, uint32_t time); - void _onError(int8_t); - void _onPoll(); - void _onTimeout(uint32_t time); - void _onDisconnect(); - void _onData(void* pbuf, size_t plen); + // system callbacks (do not call) + void _onAck(size_t len, uint32_t time); + void _onError(int8_t); + void _onPoll(); + void _onTimeout(uint32_t time); + void _onDisconnect(); + void _onData(void *pbuf, size_t plen); #ifdef ESP8266 - size_t printf_P(PGM_P formatP, ...) __attribute__((format(printf, 2, 3))); - bool text(const __FlashStringHelper* message); - bool binary(const __FlashStringHelper* message, size_t len); + size_t printf_P(PGM_P formatP, ...) __attribute__((format(printf, 2, 3))); + bool text(const __FlashStringHelper *message); + bool binary(const __FlashStringHelper *message, size_t len); #endif }; -using AwsHandshakeHandler = std::function; -using AwsEventHandler = std::function; +using AwsHandshakeHandler = std::function; +using AwsEventHandler = std::function; // WebServer Handler implementation that plays the role of a socket server class AsyncWebSocket : public AsyncWebHandler { - private: - String _url; - std::list _clients; - uint32_t _cNextId; - AwsEventHandler _eventHandler{nullptr}; - AwsHandshakeHandler _handshakeHandler; - bool _enabled; +private: + String _url; + std::list _clients; + uint32_t _cNextId; + AwsEventHandler _eventHandler{nullptr}; + AwsHandshakeHandler _handshakeHandler; + bool _enabled; #ifdef ESP32 - mutable std::mutex _lock; + mutable std::mutex _lock; #endif - public: - typedef enum { - DISCARDED = 0, - ENQUEUED = 1, - PARTIALLY_ENQUEUED = 2, - } SendStatus; +public: + typedef enum { + DISCARDED = 0, + ENQUEUED = 1, + PARTIALLY_ENQUEUED = 2, + } SendStatus; - explicit AsyncWebSocket(const char* url) : _url(url), _cNextId(1), _enabled(true) {} - AsyncWebSocket(const String& url) : _url(url), _cNextId(1), _enabled(true) {} - ~AsyncWebSocket() {}; - const char* url() const { return _url.c_str(); } - void enable(bool e) { _enabled = e; } - bool enabled() const { return _enabled; } - bool availableForWriteAll(); - bool availableForWrite(uint32_t id); + explicit AsyncWebSocket(const char *url) : _url(url), _cNextId(1), _enabled(true) {} + AsyncWebSocket(const String &url) : _url(url), _cNextId(1), _enabled(true) {} + ~AsyncWebSocket(){}; + const char *url() const { + return _url.c_str(); + } + void enable(bool e) { + _enabled = e; + } + bool enabled() const { + return _enabled; + } + bool availableForWriteAll(); + bool availableForWrite(uint32_t id); - size_t count() const; - AsyncWebSocketClient* client(uint32_t id); - bool hasClient(uint32_t id) { return client(id) != nullptr; } + size_t count() const; + AsyncWebSocketClient *client(uint32_t id); + bool hasClient(uint32_t id) { + return client(id) != nullptr; + } - void close(uint32_t id, uint16_t code = 0, const char* message = NULL); - void closeAll(uint16_t code = 0, const char* message = NULL); - void cleanupClients(uint16_t maxClients = DEFAULT_MAX_WS_CLIENTS); + void close(uint32_t id, uint16_t code = 0, const char *message = NULL); + void closeAll(uint16_t code = 0, const char *message = NULL); + void cleanupClients(uint16_t maxClients = DEFAULT_MAX_WS_CLIENTS); - bool ping(uint32_t id, const uint8_t* data = NULL, size_t len = 0); - SendStatus pingAll(const uint8_t* data = NULL, size_t len = 0); // done + bool ping(uint32_t id, const uint8_t *data = NULL, size_t len = 0); + SendStatus pingAll(const uint8_t *data = NULL, size_t len = 0); // done - bool text(uint32_t id, const uint8_t* message, size_t len); - bool text(uint32_t id, const char* message, size_t len); - bool text(uint32_t id, const char* message); - bool text(uint32_t id, const String& message); - bool text(uint32_t id, AsyncWebSocketMessageBuffer* buffer); - bool text(uint32_t id, AsyncWebSocketSharedBuffer buffer); + bool text(uint32_t id, const uint8_t *message, size_t len); + bool text(uint32_t id, const char *message, size_t len); + bool text(uint32_t id, const char *message); + bool text(uint32_t id, const String &message); + bool text(uint32_t id, AsyncWebSocketMessageBuffer *buffer); + bool text(uint32_t id, AsyncWebSocketSharedBuffer buffer); - SendStatus textAll(const uint8_t* message, size_t len); - SendStatus textAll(const char* message, size_t len); - SendStatus textAll(const char* message); - SendStatus textAll(const String& message); - SendStatus textAll(AsyncWebSocketMessageBuffer* buffer); - SendStatus textAll(AsyncWebSocketSharedBuffer buffer); + SendStatus textAll(const uint8_t *message, size_t len); + SendStatus textAll(const char *message, size_t len); + SendStatus textAll(const char *message); + SendStatus textAll(const String &message); + SendStatus textAll(AsyncWebSocketMessageBuffer *buffer); + SendStatus textAll(AsyncWebSocketSharedBuffer buffer); - bool binary(uint32_t id, const uint8_t* message, size_t len); - bool binary(uint32_t id, const char* message, size_t len); - bool binary(uint32_t id, const char* message); - bool binary(uint32_t id, const String& message); - bool binary(uint32_t id, AsyncWebSocketMessageBuffer* buffer); - bool binary(uint32_t id, AsyncWebSocketSharedBuffer buffer); + bool binary(uint32_t id, const uint8_t *message, size_t len); + bool binary(uint32_t id, const char *message, size_t len); + bool binary(uint32_t id, const char *message); + bool binary(uint32_t id, const String &message); + bool binary(uint32_t id, AsyncWebSocketMessageBuffer *buffer); + bool binary(uint32_t id, AsyncWebSocketSharedBuffer buffer); - SendStatus binaryAll(const uint8_t* message, size_t len); - SendStatus binaryAll(const char* message, size_t len); - SendStatus binaryAll(const char* message); - SendStatus binaryAll(const String& message); - SendStatus binaryAll(AsyncWebSocketMessageBuffer* buffer); - SendStatus binaryAll(AsyncWebSocketSharedBuffer buffer); + SendStatus binaryAll(const uint8_t *message, size_t len); + SendStatus binaryAll(const char *message, size_t len); + SendStatus binaryAll(const char *message); + SendStatus binaryAll(const String &message); + SendStatus binaryAll(AsyncWebSocketMessageBuffer *buffer); + SendStatus binaryAll(AsyncWebSocketSharedBuffer buffer); - size_t printf(uint32_t id, const char* format, ...) __attribute__((format(printf, 3, 4))); - size_t printfAll(const char* format, ...) __attribute__((format(printf, 2, 3))); + size_t printf(uint32_t id, const char *format, ...) __attribute__((format(printf, 3, 4))); + size_t printfAll(const char *format, ...) __attribute__((format(printf, 2, 3))); #ifdef ESP8266 - bool text(uint32_t id, const __FlashStringHelper* message); - SendStatus textAll(const __FlashStringHelper* message); - bool binary(uint32_t id, const __FlashStringHelper* message, size_t len); - SendStatus binaryAll(const __FlashStringHelper* message, size_t len); - size_t printf_P(uint32_t id, PGM_P formatP, ...) __attribute__((format(printf, 3, 4))); - size_t printfAll_P(PGM_P formatP, ...) __attribute__((format(printf, 2, 3))); + bool text(uint32_t id, const __FlashStringHelper *message); + SendStatus textAll(const __FlashStringHelper *message); + bool binary(uint32_t id, const __FlashStringHelper *message, size_t len); + SendStatus binaryAll(const __FlashStringHelper *message, size_t len); + size_t printf_P(uint32_t id, PGM_P formatP, ...) __attribute__((format(printf, 3, 4))); + size_t printfAll_P(PGM_P formatP, ...) __attribute__((format(printf, 2, 3))); #endif - void onEvent(AwsEventHandler handler) { _eventHandler = handler; } - void handleHandshake(AwsHandshakeHandler handler) { _handshakeHandler = handler; } + void onEvent(AwsEventHandler handler) { + _eventHandler = handler; + } + void handleHandshake(AwsHandshakeHandler handler) { + _handshakeHandler = handler; + } - // system callbacks (do not call) - uint32_t _getNextId() { return _cNextId++; } - AsyncWebSocketClient* _newClient(AsyncWebServerRequest* request); - void _handleEvent(AsyncWebSocketClient* client, AwsEventType type, void* arg, uint8_t* data, size_t len); - bool canHandle(AsyncWebServerRequest* request) const override final; - void handleRequest(AsyncWebServerRequest* request) override final; + // system callbacks (do not call) + uint32_t _getNextId() { + return _cNextId++; + } + AsyncWebSocketClient *_newClient(AsyncWebServerRequest *request); + void _handleEvent(AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len); + bool canHandle(AsyncWebServerRequest *request) const override final; + void handleRequest(AsyncWebServerRequest *request) override final; - // messagebuffer functions/objects. - AsyncWebSocketMessageBuffer* makeBuffer(size_t size = 0); - AsyncWebSocketMessageBuffer* makeBuffer(const uint8_t* data, size_t size); + // messagebuffer functions/objects. + AsyncWebSocketMessageBuffer *makeBuffer(size_t size = 0); + AsyncWebSocketMessageBuffer *makeBuffer(const uint8_t *data, size_t size); - std::list& getClients() { return _clients; } + std::list &getClients() { + return _clients; + } }; // WebServer response to authenticate the socket and detach the tcp client from the web server request class AsyncWebSocketResponse : public AsyncWebServerResponse { - private: - String _content; - AsyncWebSocket* _server; +private: + String _content; + AsyncWebSocket *_server; - public: - AsyncWebSocketResponse(const String& key, AsyncWebSocket* server); - void _respond(AsyncWebServerRequest* request); - size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time); - bool _sourceValid() const { return true; } +public: + AsyncWebSocketResponse(const String &key, AsyncWebSocket *server); + void _respond(AsyncWebServerRequest *request); + size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); + bool _sourceValid() const { + return true; + } }; #endif /* ASYNCWEBSOCKET_H_ */ diff --git a/src/BackPort_SHA1Builder.cpp b/src/BackPort_SHA1Builder.cpp index 08ba32c..06a73a5 100644 --- a/src/BackPort_SHA1Builder.cpp +++ b/src/BackPort_SHA1Builder.cpp @@ -281,4 +281,4 @@ void SHA1Builder::getBytes(uint8_t *output) { memcpy(output, hash, SHA1_HASH_SIZE); } -#endif // ESP_IDF_VERSION_MAJOR < 5 +#endif // ESP_IDF_VERSION_MAJOR < 5 diff --git a/src/BackPort_SHA1Builder.h b/src/BackPort_SHA1Builder.h index 8f51825..e7eafbe 100644 --- a/src/BackPort_SHA1Builder.h +++ b/src/BackPort_SHA1Builder.h @@ -24,21 +24,21 @@ #define SHA1_HASH_SIZE 20 class SHA1Builder { - private: - uint32_t total[2]; /* number of bytes processed */ - uint32_t state[5]; /* intermediate digest state */ - unsigned char buffer[64]; /* data block being processed */ - uint8_t hash[SHA1_HASH_SIZE]; /* SHA-1 result */ +private: + uint32_t total[2]; /* number of bytes processed */ + uint32_t state[5]; /* intermediate digest state */ + unsigned char buffer[64]; /* data block being processed */ + uint8_t hash[SHA1_HASH_SIZE]; /* SHA-1 result */ - void process(const uint8_t* data); + void process(const uint8_t *data); - public: - void begin(); - void add(const uint8_t* data, size_t len); - void calculate(); - void getBytes(uint8_t* output); +public: + void begin(); + void add(const uint8_t *data, size_t len); + void calculate(); + void getBytes(uint8_t *output); }; -#endif // SHA1Builder_h +#endif // SHA1Builder_h -#endif // ESP_IDF_VERSION_MAJOR < 5 +#endif // ESP_IDF_VERSION_MAJOR < 5 diff --git a/src/ChunkPrint.cpp b/src/ChunkPrint.cpp index 8c9717a..4617d34 100644 --- a/src/ChunkPrint.cpp +++ b/src/ChunkPrint.cpp @@ -1,7 +1,9 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #include -ChunkPrint::ChunkPrint(uint8_t* destination, size_t from, size_t len) - : _destination(destination), _to_skip(from), _to_write(len), _pos{0} {} +ChunkPrint::ChunkPrint(uint8_t *destination, size_t from, size_t len) : _destination(destination), _to_skip(from), _to_write(len), _pos{0} {} size_t ChunkPrint::write(uint8_t c) { if (_to_skip > 0) { @@ -13,4 +15,4 @@ size_t ChunkPrint::write(uint8_t c) { return 1; } return 0; -} \ No newline at end of file +} diff --git a/src/ChunkPrint.h b/src/ChunkPrint.h index 47988e1..04938b3 100644 --- a/src/ChunkPrint.h +++ b/src/ChunkPrint.h @@ -1,18 +1,23 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #ifndef CHUNKPRINT_H #define CHUNKPRINT_H #include class ChunkPrint : public Print { - private: - uint8_t* _destination; - size_t _to_skip; - size_t _to_write; - size_t _pos; +private: + uint8_t *_destination; + size_t _to_skip; + size_t _to_write; + size_t _pos; - public: - ChunkPrint(uint8_t* destination, size_t from, size_t len); - size_t write(uint8_t c); - size_t write(const uint8_t* buffer, size_t size) { return this->Print::write(buffer, size); } +public: + ChunkPrint(uint8_t *destination, size_t from, size_t len); + size_t write(uint8_t c); + size_t write(const uint8_t *buffer, size_t size) { + return this->Print::write(buffer, size); + } }; #endif diff --git a/src/ESPAsyncWebServer.h b/src/ESPAsyncWebServer.h index 00aed07..009d648 100644 --- a/src/ESPAsyncWebServer.h +++ b/src/ESPAsyncWebServer.h @@ -1,23 +1,6 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #ifndef _ESPAsyncWebServer_H_ #define _ESPAsyncWebServer_H_ @@ -32,32 +15,35 @@ #include #ifdef ESP32 - #include - #include +#include +#include #elif defined(ESP8266) - #include - #include -#elif defined(TARGET_RP2040) - #include - #include - #include - #include +#include +#include +#elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include +#include +#include +#include #else - #error Platform not supported +#error Platform not supported #endif #include "literals.h" -#define ASYNCWEBSERVER_VERSION "3.6.0" -#define ASYNCWEBSERVER_VERSION_MAJOR 3 -#define ASYNCWEBSERVER_VERSION_MINOR 6 -#define ASYNCWEBSERVER_VERSION_REVISION 0 +#include "AsyncWebServerVersion.h" #define ASYNCWEBSERVER_FORK_ESP32Async #ifdef ASYNCWEBSERVER_REGEX - #define ASYNCWEBSERVER_REGEX_ATTRIBUTE +#define ASYNCWEBSERVER_REGEX_ATTRIBUTE #else - #define ASYNCWEBSERVER_REGEX_ATTRIBUTE __attribute__((warning("ASYNCWEBSERVER_REGEX not defined"))) +#define ASYNCWEBSERVER_REGEX_ATTRIBUTE __attribute__((warning("ASYNCWEBSERVER_REGEX not defined"))) +#endif + +// See https://github.com/ESP32Async/ESPAsyncWebServer/commit/3d3456e9e81502a477f6498c44d0691499dda8f9#diff-646b25b11691c11dce25529e3abce843f0ba4bd07ab75ec9eee7e72b06dbf13fR388-R392 +// This setting slowdown chunk serving but avoids crashing or deadlocks in the case where slow chunk responses are created, like file serving form SD Card +#ifndef ASYNCWEBSERVER_USE_CHUNK_INFLIGHT +#define ASYNCWEBSERVER_USE_CHUNK_INFLIGHT 1 #endif class AsyncWebServer; @@ -72,10 +58,10 @@ class AsyncCallbackWebHandler; class AsyncResponseStream; class AsyncMiddlewareChain; -#if defined(TARGET_RP2040) +#if defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) typedef enum http_method WebRequestMethod; #else - #ifndef WEBSERVER_H +#ifndef WEBSERVER_H typedef enum { HTTP_GET = 0b00000001, HTTP_POST = 0b00000010, @@ -86,20 +72,20 @@ typedef enum { HTTP_OPTIONS = 0b01000000, HTTP_ANY = 0b01111111, } WebRequestMethod; - #endif +#endif #endif #ifndef HAVE_FS_FILE_OPEN_MODE namespace fs { - class FileOpenMode { - public: - static const char* read; - static const char* write; - static const char* append; - }; +class FileOpenMode { +public: + static const char *read; + static const char *write; + static const char *append; }; +}; // namespace fs #else - #include "FileOpenMode.h" +#include "FileOpenMode.h" #endif // if this value is returned when asked for data, packet will not be sent and you will be asked for data again @@ -114,20 +100,31 @@ typedef std::function ArDisconnectHandler; * */ class AsyncWebParameter { - private: - String _name; - String _value; - size_t _size; - bool _isForm; - bool _isFile; +private: + String _name; + String _value; + size_t _size; + bool _isForm; + bool _isFile; - public: - AsyncWebParameter(const String& name, const String& value, bool form = false, bool file = false, size_t size = 0) : _name(name), _value(value), _size(size), _isForm(form), _isFile(file) {} - const String& name() const { return _name; } - const String& value() const { return _value; } - size_t size() const { return _size; } - bool isPost() const { return _isForm; } - bool isFile() const { return _isFile; } +public: + AsyncWebParameter(const String &name, const String &value, bool form = false, bool file = false, size_t size = 0) + : _name(name), _value(value), _size(size), _isForm(form), _isFile(file) {} + const String &name() const { + return _name; + } + const String &value() const { + return _value; + } + size_t size() const { + return _size; + } + bool isPost() const { + return _isForm; + } + bool isFile() const { + return _isFile; + } }; /* @@ -135,264 +132,388 @@ class AsyncWebParameter { * */ class AsyncWebHeader { - private: - String _name; - String _value; +private: + String _name; + String _value; - public: - AsyncWebHeader(const AsyncWebHeader&) = default; - AsyncWebHeader(const char* name, const char* value) : _name(name), _value(value) {} - AsyncWebHeader(const String& name, const String& value) : _name(name), _value(value) {} - AsyncWebHeader(const String& data); +public: + AsyncWebHeader(const AsyncWebHeader &) = default; + AsyncWebHeader(const char *name, const char *value) : _name(name), _value(value) {} + AsyncWebHeader(const String &name, const String &value) : _name(name), _value(value) {} + AsyncWebHeader(const String &data); - AsyncWebHeader& operator=(const AsyncWebHeader&) = default; + AsyncWebHeader &operator=(const AsyncWebHeader &) = default; - const String& name() const { return _name; } - const String& value() const { return _value; } - String toString() const; + const String &name() const { + return _name; + } + const String &value() const { + return _value; + } + String toString() const; }; /* * REQUEST :: Each incoming Client is wrapped inside a Request and both live together until disconnect * */ -typedef enum { RCT_NOT_USED = -1, - RCT_DEFAULT = 0, - RCT_HTTP, - RCT_WS, - RCT_EVENT, - RCT_MAX } RequestedConnectionType; +typedef enum { + RCT_NOT_USED = -1, + RCT_DEFAULT = 0, + RCT_HTTP, + RCT_WS, + RCT_EVENT, + RCT_MAX +} RequestedConnectionType; // this enum is similar to Arduino WebServer's AsyncAuthType and PsychicHttp typedef enum { - AUTH_NONE = 0, // always allow + AUTH_NONE = 0, // always allow AUTH_BASIC = 1, AUTH_DIGEST = 2, AUTH_BEARER = 3, AUTH_OTHER = 4, - AUTH_DENIED = 255, // always returns 401 + AUTH_DENIED = 255, // always returns 401 } AsyncAuthType; -typedef std::function AwsResponseFiller; -typedef std::function AwsTemplateProcessor; +typedef std::function AwsResponseFiller; +typedef std::function AwsTemplateProcessor; + +using AsyncWebServerRequestPtr = std::weak_ptr; class AsyncWebServerRequest { - using File = fs::File; - using FS = fs::FS; - friend class AsyncWebServer; - friend class AsyncCallbackWebHandler; + using File = fs::File; + using FS = fs::FS; + friend class AsyncWebServer; + friend class AsyncCallbackWebHandler; - private: - AsyncClient* _client; - AsyncWebServer* _server; - AsyncWebHandler* _handler; - AsyncWebServerResponse* _response; - ArDisconnectHandler _onDisconnectfn; +private: + AsyncClient *_client; + AsyncWebServer *_server; + AsyncWebHandler *_handler; + AsyncWebServerResponse *_response; + ArDisconnectHandler _onDisconnectfn; - // response is sent - bool _sent = false; + bool _sent = false; // response is sent + bool _paused = false; // request is paused (request continuation) + std::shared_ptr _this; // shared pointer to this request - String _temp; - uint8_t _parseState; + String _temp; + uint8_t _parseState; - uint8_t _version; - WebRequestMethodComposite _method; - String _url; - String _host; - String _contentType; - String _boundary; - String _authorization; - RequestedConnectionType _reqconntype; - AsyncAuthType _authMethod = AsyncAuthType::AUTH_NONE; - bool _isMultipart; - bool _isPlainPost; - bool _expectingContinue; - size_t _contentLength; - size_t _parsedLength; + uint8_t _version; + WebRequestMethodComposite _method; + String _url; + String _host; + String _contentType; + String _boundary; + String _authorization; + RequestedConnectionType _reqconntype; + AsyncAuthType _authMethod = AsyncAuthType::AUTH_NONE; + bool _isMultipart; + bool _isPlainPost; + bool _expectingContinue; + size_t _contentLength; + size_t _parsedLength; - std::list _headers; - std::list _params; - std::vector _pathParams; + std::list _headers; + std::list _params; + std::list _pathParams; - std::unordered_map, std::equal_to> _attributes; + std::unordered_map, std::equal_to> _attributes; - uint8_t _multiParseState; - uint8_t _boundaryPosition; - size_t _itemStartIndex; - size_t _itemSize; - String _itemName; - String _itemFilename; - String _itemType; - String _itemValue; - uint8_t* _itemBuffer; - size_t _itemBufferIndex; - bool _itemIsFile; + uint8_t _multiParseState; + uint8_t _boundaryPosition; + size_t _itemStartIndex; + size_t _itemSize; + String _itemName; + String _itemFilename; + String _itemType; + String _itemValue; + uint8_t *_itemBuffer; + size_t _itemBufferIndex; + bool _itemIsFile; - void _onPoll(); - void _onAck(size_t len, uint32_t time); - void _onError(int8_t error); - void _onTimeout(uint32_t time); - void _onDisconnect(); - void _onData(void* buf, size_t len); + void _onPoll(); + void _onAck(size_t len, uint32_t time); + void _onError(int8_t error); + void _onTimeout(uint32_t time); + void _onDisconnect(); + void _onData(void *buf, size_t len); - void _addPathParam(const char* param); + void _addPathParam(const char *param); - bool _parseReqHead(); - bool _parseReqHeader(); - void _parseLine(); - void _parsePlainPostChar(uint8_t data); - void _parseMultipartPostByte(uint8_t data, bool last); - void _addGetParams(const String& params); + bool _parseReqHead(); + bool _parseReqHeader(); + void _parseLine(); + void _parsePlainPostChar(uint8_t data); + void _parseMultipartPostByte(uint8_t data, bool last); + void _addGetParams(const String ¶ms); - void _handleUploadStart(); - void _handleUploadByte(uint8_t data, bool last); - void _handleUploadEnd(); + void _handleUploadStart(); + void _handleUploadByte(uint8_t data, bool last); + void _handleUploadEnd(); - public: - File _tempFile; - void* _tempObject; + void _send(); + void _runMiddlewareChain(); - AsyncWebServerRequest(AsyncWebServer*, AsyncClient*); - ~AsyncWebServerRequest(); +public: + File _tempFile; + void *_tempObject; - AsyncClient* client() { return _client; } - uint8_t version() const { return _version; } - WebRequestMethodComposite method() const { return _method; } - const String& url() const { return _url; } - const String& host() const { return _host; } - const String& contentType() const { return _contentType; } - size_t contentLength() const { return _contentLength; } - bool multipart() const { return _isMultipart; } + AsyncWebServerRequest(AsyncWebServer *, AsyncClient *); + ~AsyncWebServerRequest(); - const char* methodToString() const; - const char* requestedConnTypeToString() const; + AsyncClient *client() { + return _client; + } + uint8_t version() const { + return _version; + } + WebRequestMethodComposite method() const { + return _method; + } + const String &url() const { + return _url; + } + const String &host() const { + return _host; + } + const String &contentType() const { + return _contentType; + } + size_t contentLength() const { + return _contentLength; + } + bool multipart() const { + return _isMultipart; + } - RequestedConnectionType requestedConnType() const { return _reqconntype; } - bool isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED) const; - bool isWebSocketUpgrade() const { return _method == HTTP_GET && isExpectedRequestedConnType(RCT_WS); } - bool isSSE() const { return _method == HTTP_GET && isExpectedRequestedConnType(RCT_EVENT); } - bool isHTTP() const { return isExpectedRequestedConnType(RCT_DEFAULT, RCT_HTTP); } - void onDisconnect(ArDisconnectHandler fn); + const char *methodToString() const; + const char *requestedConnTypeToString() const; - // hash is the string representation of: - // base64(user:pass) for basic or - // user:realm:md5(user:realm:pass) for digest - bool authenticate(const char* hash) const; - bool authenticate(const char* username, const char* credentials, const char* realm = NULL, bool isHash = false) const; - void requestAuthentication(const char* realm = nullptr, bool isDigest = true) { requestAuthentication(isDigest ? AsyncAuthType::AUTH_DIGEST : AsyncAuthType::AUTH_BASIC, realm); } - void requestAuthentication(AsyncAuthType method, const char* realm = nullptr, const char* _authFailMsg = nullptr); + RequestedConnectionType requestedConnType() const { + return _reqconntype; + } + bool isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2 = RCT_NOT_USED, RequestedConnectionType erct3 = RCT_NOT_USED) + const; + bool isWebSocketUpgrade() const { + return _method == HTTP_GET && isExpectedRequestedConnType(RCT_WS); + } + bool isSSE() const { + return _method == HTTP_GET && isExpectedRequestedConnType(RCT_EVENT); + } + bool isHTTP() const { + return isExpectedRequestedConnType(RCT_DEFAULT, RCT_HTTP); + } + void onDisconnect(ArDisconnectHandler fn); - void setHandler(AsyncWebHandler* handler) { _handler = handler; } + // hash is the string representation of: + // base64(user:pass) for basic or + // user:realm:md5(user:realm:pass) for digest + bool authenticate(const char *hash) const; + bool authenticate(const char *username, const char *credentials, const char *realm = NULL, bool isHash = false) const; + void requestAuthentication(const char *realm = nullptr, bool isDigest = true) { + requestAuthentication(isDigest ? AsyncAuthType::AUTH_DIGEST : AsyncAuthType::AUTH_BASIC, realm); + } + void requestAuthentication(AsyncAuthType method, const char *realm = nullptr, const char *_authFailMsg = nullptr); + + // IMPORTANT: this method is for internal use ONLY + // Please do not use it! + // It can be removed or modified at any time without notice + void setHandler(AsyncWebHandler *handler) { + _handler = handler; + } #ifndef ESP8266 - [[deprecated("All headers are now collected. Use removeHeader(name) or AsyncHeaderFreeMiddleware if you really need to free some headers.")]] + [[deprecated("All headers are now collected. Use removeHeader(name) or AsyncHeaderFreeMiddleware if you really need to free some headers.")]] #endif - void addInterestingHeader(__unused const char* name) { - } + void addInterestingHeader(__unused const char *name) { + } #ifndef ESP8266 - [[deprecated("All headers are now collected. Use removeHeader(name) or AsyncHeaderFreeMiddleware if you really need to free some headers.")]] + [[deprecated("All headers are now collected. Use removeHeader(name) or AsyncHeaderFreeMiddleware if you really need to free some headers.")]] #endif - void addInterestingHeader(__unused const String& name) { - } + void addInterestingHeader(__unused const String &name) { + } - /** - * @brief issue HTTP redirect responce with Location header + /** + * @brief issue HTTP redirect response with Location header * * @param url - url to redirect to - * @param code - responce code, default is 302 : temporary redirect + * @param code - response code, default is 302 : temporary redirect */ - void redirect(const char* url, int code = 302); - void redirect(const String& url, int code = 302) { return redirect(url.c_str(), code); }; + void redirect(const char *url, int code = 302); + void redirect(const String &url, int code = 302) { + return redirect(url.c_str(), code); + }; - void send(AsyncWebServerResponse* response); - AsyncWebServerResponse* getResponse() const { return _response; } + void send(AsyncWebServerResponse *response); + AsyncWebServerResponse *getResponse() const { + return _response; + } - void send(int code, const char* contentType = asyncsrv::empty, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr) { send(beginResponse(code, contentType, content, callback)); } - void send(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr) { send(beginResponse(code, contentType.c_str(), content, callback)); } - void send(int code, const String& contentType, const String& content, AwsTemplateProcessor callback = nullptr) { send(beginResponse(code, contentType.c_str(), content.c_str(), callback)); } + void send(int code, const char *contentType = asyncsrv::empty, const char *content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr) { + send(beginResponse(code, contentType, content, callback)); + } + void send(int code, const String &contentType, const char *content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr) { + send(beginResponse(code, contentType.c_str(), content, callback)); + } + void send(int code, const String &contentType, const String &content, AwsTemplateProcessor callback = nullptr) { + send(beginResponse(code, contentType.c_str(), content.c_str(), callback)); + } - void send(int code, const char* contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) { send(beginResponse(code, contentType, content, len, callback)); } - void send(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) { send(beginResponse(code, contentType, content, len, callback)); } + void send(int code, const char *contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr) { + send(beginResponse(code, contentType, content, len, callback)); + } + void send(int code, const String &contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr) { + send(beginResponse(code, contentType, content, len, callback)); + } - void send(FS& fs, const String& path, const char* contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr) { - if (fs.exists(path) || (!download && fs.exists(path + asyncsrv::T__gz))) { - send(beginResponse(fs, path, contentType, download, callback)); - } else - send(404); + void send(FS &fs, const String &path, const char *contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr) { + if (fs.exists(path) || (!download && fs.exists(path + asyncsrv::T__gz))) { + send(beginResponse(fs, path, contentType, download, callback)); + } else { + send(404); } - void send(FS& fs, const String& path, const String& contentType, bool download = false, AwsTemplateProcessor callback = nullptr) { send(fs, path, contentType.c_str(), download, callback); } + } + void send(FS &fs, const String &path, const String &contentType, bool download = false, AwsTemplateProcessor callback = nullptr) { + send(fs, path, contentType.c_str(), download, callback); + } - void send(File content, const String& path, const char* contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr) { - if (content) { - send(beginResponse(content, path, contentType, download, callback)); - } else - send(404); + void send(File content, const String &path, const char *contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr) { + if (content) { + send(beginResponse(content, path, contentType, download, callback)); + } else { + send(404); } - void send(File content, const String& path, const String& contentType, bool download = false, AwsTemplateProcessor callback = nullptr) { send(content, path, contentType.c_str(), download, callback); } + } + void send(File content, const String &path, const String &contentType, bool download = false, AwsTemplateProcessor callback = nullptr) { + send(content, path, contentType.c_str(), download, callback); + } - void send(Stream& stream, const char* contentType, size_t len, AwsTemplateProcessor callback = nullptr) { send(beginResponse(stream, contentType, len, callback)); } - void send(Stream& stream, const String& contentType, size_t len, AwsTemplateProcessor callback = nullptr) { send(beginResponse(stream, contentType, len, callback)); } + void send(Stream &stream, const char *contentType, size_t len, AwsTemplateProcessor callback = nullptr) { + send(beginResponse(stream, contentType, len, callback)); + } + void send(Stream &stream, const String &contentType, size_t len, AwsTemplateProcessor callback = nullptr) { + send(beginResponse(stream, contentType, len, callback)); + } - void send(const char* contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { send(beginResponse(contentType, len, callback, templateCallback)); } - void send(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { send(beginResponse(contentType, len, callback, templateCallback)); } + void send(const char *contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { + send(beginResponse(contentType, len, callback, templateCallback)); + } + void send(const String &contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { + send(beginResponse(contentType, len, callback, templateCallback)); + } - void sendChunked(const char* contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { send(beginChunkedResponse(contentType, callback, templateCallback)); } - void sendChunked(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { send(beginChunkedResponse(contentType, callback, templateCallback)); } + void sendChunked(const char *contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { + send(beginChunkedResponse(contentType, callback, templateCallback)); + } + void sendChunked(const String &contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { + send(beginChunkedResponse(contentType, callback, templateCallback)); + } #ifndef ESP8266 - [[deprecated("Replaced by send(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr)")]] + [[deprecated("Replaced by send(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr)")]] #endif - void send_P(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) { - send(code, contentType, content, len, callback); - } + void send_P(int code, const String &contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr) { + send(code, contentType, content, len, callback); + } #ifndef ESP8266 - [[deprecated("Replaced by send(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr)")]] - void send_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback = nullptr) { - send(code, contentType, content, callback); - } + [[deprecated("Replaced by send(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr)")]] + void send_P(int code, const String &contentType, PGM_P content, AwsTemplateProcessor callback = nullptr) { + send(code, contentType, content, callback); + } #else - void send_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback = nullptr) { - send(beginResponse_P(code, contentType, content, callback)); - } + void send_P(int code, const String &contentType, PGM_P content, AwsTemplateProcessor callback = nullptr) { + send(beginResponse_P(code, contentType, content, callback)); + } #endif - AsyncWebServerResponse* beginResponse(int code, const char* contentType = asyncsrv::empty, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr); - AsyncWebServerResponse* beginResponse(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr) { return beginResponse(code, contentType.c_str(), content, callback); } - AsyncWebServerResponse* beginResponse(int code, const String& contentType, const String& content, AwsTemplateProcessor callback = nullptr) { return beginResponse(code, contentType.c_str(), content.c_str(), callback); } + AsyncWebServerResponse * + beginResponse(int code, const char *contentType = asyncsrv::empty, const char *content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr); + AsyncWebServerResponse *beginResponse(int code, const String &contentType, const char *content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr) { + return beginResponse(code, contentType.c_str(), content, callback); + } + AsyncWebServerResponse *beginResponse(int code, const String &contentType, const String &content, AwsTemplateProcessor callback = nullptr) { + return beginResponse(code, contentType.c_str(), content.c_str(), callback); + } - AsyncWebServerResponse* beginResponse(int code, const char* contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr); - AsyncWebServerResponse* beginResponse(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) { return beginResponse(code, contentType.c_str(), content, len, callback); } + AsyncWebServerResponse *beginResponse(int code, const char *contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr); + AsyncWebServerResponse *beginResponse(int code, const String &contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr) { + return beginResponse(code, contentType.c_str(), content, len, callback); + } - AsyncWebServerResponse* beginResponse(FS& fs, const String& path, const char* contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr); - AsyncWebServerResponse* beginResponse(FS& fs, const String& path, const String& contentType = emptyString, bool download = false, AwsTemplateProcessor callback = nullptr) { return beginResponse(fs, path, contentType.c_str(), download, callback); } + AsyncWebServerResponse * + beginResponse(FS &fs, const String &path, const char *contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr); + AsyncWebServerResponse * + beginResponse(FS &fs, const String &path, const String &contentType = emptyString, bool download = false, AwsTemplateProcessor callback = nullptr) { + return beginResponse(fs, path, contentType.c_str(), download, callback); + } - AsyncWebServerResponse* beginResponse(File content, const String& path, const char* contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr); - AsyncWebServerResponse* beginResponse(File content, const String& path, const String& contentType = emptyString, bool download = false, AwsTemplateProcessor callback = nullptr) { return beginResponse(content, path, contentType.c_str(), download, callback); } + AsyncWebServerResponse * + beginResponse(File content, const String &path, const char *contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr); + AsyncWebServerResponse * + beginResponse(File content, const String &path, const String &contentType = emptyString, bool download = false, AwsTemplateProcessor callback = nullptr) { + return beginResponse(content, path, contentType.c_str(), download, callback); + } - AsyncWebServerResponse* beginResponse(Stream& stream, const char* contentType, size_t len, AwsTemplateProcessor callback = nullptr); - AsyncWebServerResponse* beginResponse(Stream& stream, const String& contentType, size_t len, AwsTemplateProcessor callback = nullptr) { return beginResponse(stream, contentType.c_str(), len, callback); } + AsyncWebServerResponse *beginResponse(Stream &stream, const char *contentType, size_t len, AwsTemplateProcessor callback = nullptr); + AsyncWebServerResponse *beginResponse(Stream &stream, const String &contentType, size_t len, AwsTemplateProcessor callback = nullptr) { + return beginResponse(stream, contentType.c_str(), len, callback); + } - AsyncWebServerResponse* beginResponse(const char* contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); - AsyncWebServerResponse* beginResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { return beginResponse(contentType.c_str(), len, callback, templateCallback); } + AsyncWebServerResponse *beginResponse(const char *contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); + AsyncWebServerResponse *beginResponse(const String &contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) { + return beginResponse(contentType.c_str(), len, callback, templateCallback); + } - AsyncWebServerResponse* beginChunkedResponse(const char* contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); - AsyncWebServerResponse* beginChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); + AsyncWebServerResponse *beginChunkedResponse(const char *contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); + AsyncWebServerResponse *beginChunkedResponse(const String &contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); - AsyncResponseStream* beginResponseStream(const char* contentType, size_t bufferSize = RESPONSE_STREAM_BUFFER_SIZE); - AsyncResponseStream* beginResponseStream(const String& contentType, size_t bufferSize = RESPONSE_STREAM_BUFFER_SIZE) { return beginResponseStream(contentType.c_str(), bufferSize); } + AsyncResponseStream *beginResponseStream(const char *contentType, size_t bufferSize = RESPONSE_STREAM_BUFFER_SIZE); + AsyncResponseStream *beginResponseStream(const String &contentType, size_t bufferSize = RESPONSE_STREAM_BUFFER_SIZE) { + return beginResponseStream(contentType.c_str(), bufferSize); + } #ifndef ESP8266 - [[deprecated("Replaced by beginResponse(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr)")]] + [[deprecated("Replaced by beginResponse(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr)")]] #endif - AsyncWebServerResponse* beginResponse_P(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) { - return beginResponse(code, contentType.c_str(), content, len, callback); - } + AsyncWebServerResponse *beginResponse_P(int code, const String &contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr) { + return beginResponse(code, contentType.c_str(), content, len, callback); + } #ifndef ESP8266 - [[deprecated("Replaced by beginResponse(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr)")]] + [[deprecated("Replaced by beginResponse(int code, const String& contentType, const char* content = asyncsrv::empty, AwsTemplateProcessor callback = nullptr)" + )]] #endif - AsyncWebServerResponse* beginResponse_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback = nullptr); + AsyncWebServerResponse *beginResponse_P(int code, const String &contentType, PGM_P content, AwsTemplateProcessor callback = nullptr); - /** + /** + * @brief Request Continuation: this function pauses the current request and returns a weak pointer (AsyncWebServerRequestPtr is a std::weak_ptr) to the request in order to reuse it later on. + * The middelware chain will continue to be processed until the end, but no response will be sent. + * To resume operations (send the request), the request must be retrieved from the weak pointer and a send() function must be called. + * AsyncWebServerRequestPtr is the only object allowed to exist the scope of the request handler. + * @warning This function should be called from within the context of a request (in a handler or middleware for example). + * @warning While the request is paused, if the client aborts the request, the latter will be disconnected and deleted. + * So it is the responsibility of the user to check the validity of the request pointer (AsyncWebServerRequestPtr) before using it by calling lock() and/or expired(). + */ + AsyncWebServerRequestPtr pause(); + + bool isPaused() const { + return _paused; + } + + /** + * @brief Aborts the request and close the client (RST). + * Mark the request as sent. + * If it was paused, it will be unpaused and it won't be possible to resume it. + */ + void abort(); + + bool isSent() const { + return _sent; + } + + /** * @brief Get the Request parameter by name * * @param name @@ -400,113 +521,147 @@ class AsyncWebServerRequest { * @param file * @return const AsyncWebParameter* */ - const AsyncWebParameter* getParam(const char* name, bool post = false, bool file = false) const; + const AsyncWebParameter *getParam(const char *name, bool post = false, bool file = false) const; - const AsyncWebParameter* getParam(const String& name, bool post = false, bool file = false) const { return getParam(name.c_str(), post, file); }; + const AsyncWebParameter *getParam(const String &name, bool post = false, bool file = false) const { + return getParam(name.c_str(), post, file); + }; #ifdef ESP8266 - const AsyncWebParameter* getParam(const __FlashStringHelper* data, bool post, bool file) const; + const AsyncWebParameter *getParam(const __FlashStringHelper *data, bool post, bool file) const; #endif - /** + /** * @brief Get request parameter by number * i.e., n-th parameter * @param num * @return const AsyncWebParameter* */ - const AsyncWebParameter* getParam(size_t num) const; + const AsyncWebParameter *getParam(size_t num) const; - size_t args() const { return params(); } // get arguments count + size_t args() const { + return params(); + } // get arguments count - // get request argument value by name - const String& arg(const char* name) const; - // get request argument value by name - const String& arg(const String& name) const { return arg(name.c_str()); }; + // get request argument value by name + const String &arg(const char *name) const; + // get request argument value by name + const String &arg(const String &name) const { + return arg(name.c_str()); + }; #ifdef ESP8266 - const String& arg(const __FlashStringHelper* data) const; // get request argument value by F(name) + const String &arg(const __FlashStringHelper *data) const; // get request argument value by F(name) #endif - const String& arg(size_t i) const; // get request argument value by number - const String& argName(size_t i) const; // get request argument name by number - bool hasArg(const char* name) const; // check if argument exists - bool hasArg(const String& name) const { return hasArg(name.c_str()); }; + const String &arg(size_t i) const; // get request argument value by number + const String &argName(size_t i) const; // get request argument name by number + bool hasArg(const char *name) const; // check if argument exists + bool hasArg(const String &name) const { + return hasArg(name.c_str()); + }; #ifdef ESP8266 - bool hasArg(const __FlashStringHelper* data) const; // check if F(argument) exists + bool hasArg(const __FlashStringHelper *data) const; // check if F(argument) exists #endif - const String& ASYNCWEBSERVER_REGEX_ATTRIBUTE pathArg(size_t i) const; + const String &ASYNCWEBSERVER_REGEX_ATTRIBUTE pathArg(size_t i) const; - // get request header value by name - const String& header(const char* name) const; - const String& header(const String& name) const { return header(name.c_str()); }; + // get request header value by name + const String &header(const char *name) const; + const String &header(const String &name) const { + return header(name.c_str()); + }; #ifdef ESP8266 - const String& header(const __FlashStringHelper* data) const; // get request header value by F(name) + const String &header(const __FlashStringHelper *data) const; // get request header value by F(name) #endif - const String& header(size_t i) const; // get request header value by number - const String& headerName(size_t i) const; // get request header name by number + const String &header(size_t i) const; // get request header value by number + const String &headerName(size_t i) const; // get request header name by number - size_t headers() const; // get header count + size_t headers() const; // get header count - // check if header exists - bool hasHeader(const char* name) const; - bool hasHeader(const String& name) const { return hasHeader(name.c_str()); }; + // check if header exists + bool hasHeader(const char *name) const; + bool hasHeader(const String &name) const { + return hasHeader(name.c_str()); + }; #ifdef ESP8266 - bool hasHeader(const __FlashStringHelper* data) const; // check if header exists + bool hasHeader(const __FlashStringHelper *data) const; // check if header exists #endif - const AsyncWebHeader* getHeader(const char* name) const; - const AsyncWebHeader* getHeader(const String& name) const { return getHeader(name.c_str()); }; + const AsyncWebHeader *getHeader(const char *name) const; + const AsyncWebHeader *getHeader(const String &name) const { + return getHeader(name.c_str()); + }; #ifdef ESP8266 - const AsyncWebHeader* getHeader(const __FlashStringHelper* data) const; + const AsyncWebHeader *getHeader(const __FlashStringHelper *data) const; #endif - const AsyncWebHeader* getHeader(size_t num) const; + const AsyncWebHeader *getHeader(size_t num) const; - const std::list& getHeaders() const { return _headers; } + const std::list &getHeaders() const { + return _headers; + } - size_t getHeaderNames(std::vector& names) const; + size_t getHeaderNames(std::vector &names) const; - // Remove a header from the request. - // It will free the memory and prevent the header to be seen during request processing. - bool removeHeader(const char* name); - // Remove all request headers. - void removeHeaders() { _headers.clear(); } + // Remove a header from the request. + // It will free the memory and prevent the header to be seen during request processing. + bool removeHeader(const char *name); + // Remove all request headers. + void removeHeaders() { + _headers.clear(); + } - size_t params() const; // get arguments count - bool hasParam(const char* name, bool post = false, bool file = false) const; - bool hasParam(const String& name, bool post = false, bool file = false) const { return hasParam(name.c_str(), post, file); }; + size_t params() const; // get arguments count + bool hasParam(const char *name, bool post = false, bool file = false) const; + bool hasParam(const String &name, bool post = false, bool file = false) const { + return hasParam(name.c_str(), post, file); + }; #ifdef ESP8266 - bool hasParam(const __FlashStringHelper* data, bool post = false, bool file = false) const { return hasParam(String(data).c_str(), post, file); }; + bool hasParam(const __FlashStringHelper *data, bool post = false, bool file = false) const { + return hasParam(String(data).c_str(), post, file); + }; #endif - // REQUEST ATTRIBUTES + // REQUEST ATTRIBUTES - void setAttribute(const char* name, const char* value) { _attributes[name] = value; } - void setAttribute(const char* name, bool value) { _attributes[name] = value ? "1" : emptyString; } - void setAttribute(const char* name, long value) { _attributes[name] = String(value); } - void setAttribute(const char* name, float value, unsigned int decimalPlaces = 2) { _attributes[name] = String(value, decimalPlaces); } - void setAttribute(const char* name, double value, unsigned int decimalPlaces = 2) { _attributes[name] = String(value, decimalPlaces); } + void setAttribute(const char *name, const char *value) { + _attributes[name] = value; + } + void setAttribute(const char *name, bool value) { + _attributes[name] = value ? "1" : emptyString; + } + void setAttribute(const char *name, long value) { + _attributes[name] = String(value); + } + void setAttribute(const char *name, float value, unsigned int decimalPlaces = 2) { + _attributes[name] = String(value, decimalPlaces); + } + void setAttribute(const char *name, double value, unsigned int decimalPlaces = 2) { + _attributes[name] = String(value, decimalPlaces); + } - bool hasAttribute(const char* name) const { return _attributes.find(name) != _attributes.end(); } + bool hasAttribute(const char *name) const { + return _attributes.find(name) != _attributes.end(); + } - const String& getAttribute(const char* name, const String& defaultValue = emptyString) const; - bool getAttribute(const char* name, bool defaultValue) const; - long getAttribute(const char* name, long defaultValue) const; - float getAttribute(const char* name, float defaultValue) const; - double getAttribute(const char* name, double defaultValue) const; + const String &getAttribute(const char *name, const String &defaultValue = emptyString) const; + bool getAttribute(const char *name, bool defaultValue) const; + long getAttribute(const char *name, long defaultValue) const; + float getAttribute(const char *name, float defaultValue) const; + double getAttribute(const char *name, double defaultValue) const; - String urlDecode(const String& text) const; + String urlDecode(const String &text) const; }; /* * FILTER :: Callback to filter AsyncWebRewrite and AsyncWebHandler (done by the Server) * */ -using ArRequestFilterFunction = std::function; +using ArRequestFilterFunction = std::function; -bool ON_STA_FILTER(AsyncWebServerRequest* request); +bool ON_STA_FILTER(AsyncWebServerRequest *request); -bool ON_AP_FILTER(AsyncWebServerRequest* request); +bool ON_AP_FILTER(AsyncWebServerRequest *request); /* * MIDDLEWARE :: Request interceptor, assigned to a AsyncWebHandler (or the server), which can be used: @@ -515,178 +670,220 @@ bool ON_AP_FILTER(AsyncWebServerRequest* request); * */ using ArMiddlewareNext = std::function; -using ArMiddlewareCallback = std::function; +using ArMiddlewareCallback = std::function; // Middleware is a base class for all middleware class AsyncMiddleware { - public: - virtual ~AsyncMiddleware() {} - virtual void run(__unused AsyncWebServerRequest* request, __unused ArMiddlewareNext next) { return next(); }; +public: + virtual ~AsyncMiddleware() {} + virtual void run(__unused AsyncWebServerRequest *request, __unused ArMiddlewareNext next) { + return next(); + }; - private: - friend class AsyncWebHandler; - friend class AsyncEventSource; - friend class AsyncMiddlewareChain; - bool _freeOnRemoval = false; +private: + friend class AsyncWebHandler; + friend class AsyncEventSource; + friend class AsyncMiddlewareChain; + bool _freeOnRemoval = false; }; // Create a custom middleware by providing an anonymous callback function class AsyncMiddlewareFunction : public AsyncMiddleware { - public: - AsyncMiddlewareFunction(ArMiddlewareCallback fn) : _fn(fn) {} - void run(AsyncWebServerRequest* request, ArMiddlewareNext next) override { return _fn(request, next); }; +public: + AsyncMiddlewareFunction(ArMiddlewareCallback fn) : _fn(fn) {} + void run(AsyncWebServerRequest *request, ArMiddlewareNext next) override { + return _fn(request, next); + }; - private: - ArMiddlewareCallback _fn; +private: + ArMiddlewareCallback _fn; }; // For internal use only: super class to add/remove middleware to server or handlers class AsyncMiddlewareChain { - public: - ~AsyncMiddlewareChain(); +public: + ~AsyncMiddlewareChain(); - void addMiddleware(ArMiddlewareCallback fn); - void addMiddleware(AsyncMiddleware* middleware); - void addMiddlewares(std::vector middlewares); - bool removeMiddleware(AsyncMiddleware* middleware); + void addMiddleware(ArMiddlewareCallback fn); + void addMiddleware(AsyncMiddleware *middleware); + void addMiddlewares(std::vector middlewares); + bool removeMiddleware(AsyncMiddleware *middleware); - // For internal use only - void _runChain(AsyncWebServerRequest* request, ArMiddlewareNext finalizer); + // For internal use only + void _runChain(AsyncWebServerRequest *request, ArMiddlewareNext finalizer); - protected: - std::list _middlewares; +protected: + std::list _middlewares; }; // AsyncAuthenticationMiddleware is a middleware that checks if the request is authenticated class AsyncAuthenticationMiddleware : public AsyncMiddleware { - public: - void setUsername(const char* username); - void setPassword(const char* password); - void setPasswordHash(const char* hash); +public: + void setUsername(const char *username); + void setPassword(const char *password); + void setPasswordHash(const char *hash); - void setRealm(const char* realm) { _realm = realm; } - void setAuthFailureMessage(const char* message) { _authFailMsg = message; } + void setRealm(const char *realm) { + _realm = realm; + } + void setAuthFailureMessage(const char *message) { + _authFailMsg = message; + } - // set the authentication method to use - // default is AUTH_NONE: no authentication required - // AUTH_BASIC: basic authentication - // AUTH_DIGEST: digest authentication - // AUTH_BEARER: bearer token authentication - // AUTH_OTHER: other authentication method - // AUTH_DENIED: always return 401 Unauthorized - // if a method is set but no username or password is set, authentication will be ignored - void setAuthType(AsyncAuthType authMethod) { _authMethod = authMethod; } + // set the authentication method to use + // default is AUTH_NONE: no authentication required + // AUTH_BASIC: basic authentication + // AUTH_DIGEST: digest authentication + // AUTH_BEARER: bearer token authentication + // AUTH_OTHER: other authentication method + // AUTH_DENIED: always return 401 Unauthorized + // if a method is set but no username or password is set, authentication will be ignored + void setAuthType(AsyncAuthType authMethod) { + _authMethod = authMethod; + } - // precompute and store the hash value based on the username, password, realm. - // can be used for DIGEST and BASIC to avoid recomputing the hash for each request. - // returns true if the hash was successfully generated and replaced - bool generateHash(); + // precompute and store the hash value based on the username, password, realm. + // can be used for DIGEST and BASIC to avoid recomputing the hash for each request. + // returns true if the hash was successfully generated and replaced + bool generateHash(); - // returns true if the username and password (or hash) are set - bool hasCredentials() const { return _hasCreds; } + // returns true if the username and password (or hash) are set + bool hasCredentials() const { + return _hasCreds; + } - bool allowed(AsyncWebServerRequest* request) const; + bool allowed(AsyncWebServerRequest *request) const; - void run(AsyncWebServerRequest* request, ArMiddlewareNext next); + void run(AsyncWebServerRequest *request, ArMiddlewareNext next); - private: - String _username; - String _credentials; - bool _hash = false; +private: + String _username; + String _credentials; + bool _hash = false; - String _realm = asyncsrv::T_LOGIN_REQ; - AsyncAuthType _authMethod = AsyncAuthType::AUTH_NONE; - String _authFailMsg; - bool _hasCreds = false; + String _realm = asyncsrv::T_LOGIN_REQ; + AsyncAuthType _authMethod = AsyncAuthType::AUTH_NONE; + String _authFailMsg; + bool _hasCreds = false; }; -using ArAuthorizeFunction = std::function; +using ArAuthorizeFunction = std::function; // AsyncAuthorizationMiddleware is a middleware that checks if the request is authorized class AsyncAuthorizationMiddleware : public AsyncMiddleware { - public: - AsyncAuthorizationMiddleware(ArAuthorizeFunction authorizeConnectHandler) : _code(403), _authz(authorizeConnectHandler) {} - AsyncAuthorizationMiddleware(int code, ArAuthorizeFunction authorizeConnectHandler) : _code(code), _authz(authorizeConnectHandler) {} +public: + AsyncAuthorizationMiddleware(ArAuthorizeFunction authorizeConnectHandler) : _code(403), _authz(authorizeConnectHandler) {} + AsyncAuthorizationMiddleware(int code, ArAuthorizeFunction authorizeConnectHandler) : _code(code), _authz(authorizeConnectHandler) {} - void run(AsyncWebServerRequest* request, ArMiddlewareNext next) { return _authz && !_authz(request) ? request->send(_code) : next(); } + void run(AsyncWebServerRequest *request, ArMiddlewareNext next) { + return _authz && !_authz(request) ? request->send(_code) : next(); + } - private: - int _code; - ArAuthorizeFunction _authz; +private: + int _code; + ArAuthorizeFunction _authz; }; // remove all headers from the incoming request except the ones provided in the constructor class AsyncHeaderFreeMiddleware : public AsyncMiddleware { - public: - void keep(const char* name) { _toKeep.push_back(name); } - void unKeep(const char* name) { _toKeep.erase(std::remove(_toKeep.begin(), _toKeep.end(), name), _toKeep.end()); } +public: + void keep(const char *name) { + _toKeep.push_back(name); + } + void unKeep(const char *name) { + _toKeep.remove(name); + } - void run(AsyncWebServerRequest* request, ArMiddlewareNext next); + void run(AsyncWebServerRequest *request, ArMiddlewareNext next); - private: - std::vector _toKeep; +private: + std::list _toKeep; }; // filter out specific headers from the incoming request class AsyncHeaderFilterMiddleware : public AsyncMiddleware { - public: - void filter(const char* name) { _toRemove.push_back(name); } - void unFilter(const char* name) { _toRemove.erase(std::remove(_toRemove.begin(), _toRemove.end(), name), _toRemove.end()); } +public: + void filter(const char *name) { + _toRemove.push_back(name); + } + void unFilter(const char *name) { + _toRemove.remove(name); + } - void run(AsyncWebServerRequest* request, ArMiddlewareNext next); + void run(AsyncWebServerRequest *request, ArMiddlewareNext next); - private: - std::vector _toRemove; +private: + std::list _toRemove; }; // curl-like logging of incoming requests class AsyncLoggingMiddleware : public AsyncMiddleware { - public: - void setOutput(Print& output) { _out = &output; } - void setEnabled(bool enabled) { _enabled = enabled; } - bool isEnabled() const { return _enabled && _out; } +public: + void setOutput(Print &output) { + _out = &output; + } + void setEnabled(bool enabled) { + _enabled = enabled; + } + bool isEnabled() const { + return _enabled && _out; + } - void run(AsyncWebServerRequest* request, ArMiddlewareNext next); + void run(AsyncWebServerRequest *request, ArMiddlewareNext next); - private: - Print* _out = nullptr; - bool _enabled = true; +private: + Print *_out = nullptr; + bool _enabled = true; }; // CORS Middleware class AsyncCorsMiddleware : public AsyncMiddleware { - public: - void setOrigin(const char* origin) { _origin = origin; } - void setMethods(const char* methods) { _methods = methods; } - void setHeaders(const char* headers) { _headers = headers; } - void setAllowCredentials(bool credentials) { _credentials = credentials; } - void setMaxAge(uint32_t seconds) { _maxAge = seconds; } +public: + void setOrigin(const char *origin) { + _origin = origin; + } + void setMethods(const char *methods) { + _methods = methods; + } + void setHeaders(const char *headers) { + _headers = headers; + } + void setAllowCredentials(bool credentials) { + _credentials = credentials; + } + void setMaxAge(uint32_t seconds) { + _maxAge = seconds; + } - void addCORSHeaders(AsyncWebServerResponse* response); + void addCORSHeaders(AsyncWebServerResponse *response); - void run(AsyncWebServerRequest* request, ArMiddlewareNext next); + void run(AsyncWebServerRequest *request, ArMiddlewareNext next); - private: - String _origin = "*"; - String _methods = "*"; - String _headers = "*"; - bool _credentials = true; - uint32_t _maxAge = 86400; +private: + String _origin = "*"; + String _methods = "*"; + String _headers = "*"; + bool _credentials = true; + uint32_t _maxAge = 86400; }; // Rate limit Middleware class AsyncRateLimitMiddleware : public AsyncMiddleware { - public: - void setMaxRequests(size_t maxRequests) { _maxRequests = maxRequests; } - void setWindowSize(uint32_t seconds) { _windowSizeMillis = seconds * 1000; } +public: + void setMaxRequests(size_t maxRequests) { + _maxRequests = maxRequests; + } + void setWindowSize(uint32_t seconds) { + _windowSizeMillis = seconds * 1000; + } - bool isRequestAllowed(uint32_t& retryAfterSeconds); + bool isRequestAllowed(uint32_t &retryAfterSeconds); - void run(AsyncWebServerRequest* request, ArMiddlewareNext next); + void run(AsyncWebServerRequest *request, ArMiddlewareNext next); - private: - size_t _maxRequests = 0; - uint32_t _windowSizeMillis = 0; - std::list _requestTimes; +private: + size_t _maxRequests = 0; + uint32_t _windowSizeMillis = 0; + std::list _requestTimes; }; /* @@ -694,30 +891,40 @@ class AsyncRateLimitMiddleware : public AsyncMiddleware { * */ class AsyncWebRewrite { - protected: - String _from; - String _toUrl; - String _params; - ArRequestFilterFunction _filter{nullptr}; +protected: + String _from; + String _toUrl; + String _params; + ArRequestFilterFunction _filter{nullptr}; - public: - AsyncWebRewrite(const char* from, const char* to) : _from(from), _toUrl(to) { - int index = _toUrl.indexOf('?'); - if (index > 0) { - _params = _toUrl.substring(index + 1); - _toUrl = _toUrl.substring(0, index); - } +public: + AsyncWebRewrite(const char *from, const char *to) : _from(from), _toUrl(to) { + int index = _toUrl.indexOf('?'); + if (index > 0) { + _params = _toUrl.substring(index + 1); + _toUrl = _toUrl.substring(0, index); } - virtual ~AsyncWebRewrite() {} - AsyncWebRewrite& setFilter(ArRequestFilterFunction fn) { - _filter = fn; - return *this; - } - bool filter(AsyncWebServerRequest* request) const { return _filter == NULL || _filter(request); } - const String& from(void) const { return _from; } - const String& toUrl(void) const { return _toUrl; } - const String& params(void) const { return _params; } - virtual bool match(AsyncWebServerRequest* request) { return from() == request->url() && filter(request); } + } + virtual ~AsyncWebRewrite() {} + AsyncWebRewrite &setFilter(ArRequestFilterFunction fn) { + _filter = fn; + return *this; + } + bool filter(AsyncWebServerRequest *request) const { + return _filter == NULL || _filter(request); + } + const String &from(void) const { + return _from; + } + const String &toUrl(void) const { + return _toUrl; + } + const String ¶ms(void) const { + return _params; + } + virtual bool match(AsyncWebServerRequest *request) { + return from() == request->url() && filter(request); + } }; /* @@ -725,22 +932,45 @@ class AsyncWebRewrite { * */ class AsyncWebHandler : public AsyncMiddlewareChain { - protected: - ArRequestFilterFunction _filter = nullptr; - AsyncAuthenticationMiddleware* _authMiddleware = nullptr; +protected: + ArRequestFilterFunction _filter = nullptr; + AsyncAuthenticationMiddleware *_authMiddleware = nullptr; + bool _skipServerMiddlewares = false; - public: - AsyncWebHandler() {} - virtual ~AsyncWebHandler() {} - AsyncWebHandler& setFilter(ArRequestFilterFunction fn); - AsyncWebHandler& setAuthentication(const char* username, const char* password, AsyncAuthType authMethod = AsyncAuthType::AUTH_DIGEST); - AsyncWebHandler& setAuthentication(const String& username, const String& password, AsyncAuthType authMethod = AsyncAuthType::AUTH_DIGEST) { return setAuthentication(username.c_str(), password.c_str(), authMethod); }; - bool filter(AsyncWebServerRequest* request) { return _filter == NULL || _filter(request); } - virtual bool canHandle(AsyncWebServerRequest* request __attribute__((unused))) const { return false; } - virtual void handleRequest(__unused AsyncWebServerRequest* request) {} - virtual void handleUpload(__unused AsyncWebServerRequest* request, __unused const String& filename, __unused size_t index, __unused uint8_t* data, __unused size_t len, __unused bool final) {} - virtual void handleBody(__unused AsyncWebServerRequest* request, __unused uint8_t* data, __unused size_t len, __unused size_t index, __unused size_t total) {} - virtual bool isRequestHandlerTrivial() const { return true; } +public: + AsyncWebHandler() {} + virtual ~AsyncWebHandler() {} + AsyncWebHandler &setFilter(ArRequestFilterFunction fn); + AsyncWebHandler &setAuthentication(const char *username, const char *password, AsyncAuthType authMethod = AsyncAuthType::AUTH_DIGEST); + AsyncWebHandler &setAuthentication(const String &username, const String &password, AsyncAuthType authMethod = AsyncAuthType::AUTH_DIGEST) { + return setAuthentication(username.c_str(), password.c_str(), authMethod); + }; + AsyncWebHandler &setSkipServerMiddlewares(bool state) { + _skipServerMiddlewares = state; + return *this; + } + // skip all globally defined server middlewares for this handler and only execute those defined for this handler specifically + AsyncWebHandler &skipServerMiddlewares() { + return setSkipServerMiddlewares(true); + } + bool mustSkipServerMiddlewares() const { + return _skipServerMiddlewares; + } + bool filter(AsyncWebServerRequest *request) { + return _filter == NULL || _filter(request); + } + virtual bool canHandle(AsyncWebServerRequest *request __attribute__((unused))) const { + return false; + } + virtual void handleRequest(__unused AsyncWebServerRequest *request) {} + virtual void handleUpload( + __unused AsyncWebServerRequest *request, __unused const String &filename, __unused size_t index, __unused uint8_t *data, __unused size_t len, + __unused bool final + ) {} + virtual void handleBody(__unused AsyncWebServerRequest *request, __unused uint8_t *data, __unused size_t len, __unused size_t index, __unused size_t total) {} + virtual bool isRequestHandlerTrivial() const { + return true; + } }; /* @@ -757,86 +987,102 @@ typedef enum { } WebResponseState; class AsyncWebServerResponse { - protected: - int _code; - std::list _headers; - String _contentType; - size_t _contentLength; - bool _sendContentLength; - bool _chunked; - size_t _headLength; - size_t _sentLength; - size_t _ackedLength; - size_t _writtenLength; - WebResponseState _state; +protected: + int _code; + std::list _headers; + String _contentType; + size_t _contentLength; + bool _sendContentLength; + bool _chunked; + size_t _headLength; + size_t _sentLength; + size_t _ackedLength; + size_t _writtenLength; + WebResponseState _state; - public: - static const char* responseCodeToString(int code); + static bool headerMustBePresentOnce(const String &name); - public: - AsyncWebServerResponse(); - virtual ~AsyncWebServerResponse() {} - void setCode(int code); - int code() const { return _code; } - void setContentLength(size_t len); - void setContentType(const String& type) { setContentType(type.c_str()); } - void setContentType(const char* type); - bool addHeader(const char* name, const char* value, bool replaceExisting = true); - bool addHeader(const String& name, const String& value, bool replaceExisting = true) { return addHeader(name.c_str(), value.c_str(), replaceExisting); } - bool addHeader(const char* name, long value, bool replaceExisting = true) { return addHeader(name, String(value), replaceExisting); } - bool addHeader(const String& name, long value, bool replaceExisting = true) { return addHeader(name.c_str(), value, replaceExisting); } - bool removeHeader(const char* name); - const AsyncWebHeader* getHeader(const char* name) const; - const std::list& getHeaders() const { return _headers; } +public: + static const char *responseCodeToString(int code); + +public: + AsyncWebServerResponse(); + virtual ~AsyncWebServerResponse() {} + void setCode(int code); + int code() const { + return _code; + } + void setContentLength(size_t len); + void setContentType(const String &type) { + setContentType(type.c_str()); + } + void setContentType(const char *type); + bool addHeader(const char *name, const char *value, bool replaceExisting = true); + bool addHeader(const String &name, const String &value, bool replaceExisting = true) { + return addHeader(name.c_str(), value.c_str(), replaceExisting); + } + bool addHeader(const char *name, long value, bool replaceExisting = true) { + return addHeader(name, String(value), replaceExisting); + } + bool addHeader(const String &name, long value, bool replaceExisting = true) { + return addHeader(name.c_str(), value, replaceExisting); + } + bool removeHeader(const char *name); + bool removeHeader(const char *name, const char *value); + const AsyncWebHeader *getHeader(const char *name) const; + const std::list &getHeaders() const { + return _headers; + } #ifndef ESP8266 - [[deprecated("Use instead: _assembleHead(String& buffer, uint8_t version)")]] + [[deprecated("Use instead: _assembleHead(String& buffer, uint8_t version)")]] #endif - String _assembleHead(uint8_t version) { - String buffer; - _assembleHead(buffer, version); - return buffer; - } - void _assembleHead(String& buffer, uint8_t version); + String _assembleHead(uint8_t version) { + String buffer; + _assembleHead(buffer, version); + return buffer; + } + void _assembleHead(String &buffer, uint8_t version); - virtual bool _started() const; - virtual bool _finished() const; - virtual bool _failed() const; - virtual bool _sourceValid() const; - virtual void _respond(AsyncWebServerRequest* request); - virtual size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time); + virtual bool _started() const; + virtual bool _finished() const; + virtual bool _failed() const; + virtual bool _sourceValid() const; + virtual void _respond(AsyncWebServerRequest *request); + virtual size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time); }; /* * SERVER :: One instance * */ -typedef std::function ArRequestHandlerFunction; -typedef std::function ArUploadHandlerFunction; -typedef std::function ArBodyHandlerFunction; +typedef std::function ArRequestHandlerFunction; +typedef std::function + ArUploadHandlerFunction; +typedef std::function ArBodyHandlerFunction; class AsyncWebServer : public AsyncMiddlewareChain { - protected: - AsyncServer _server; - std::list> _rewrites; - std::list> _handlers; - AsyncCallbackWebHandler* _catchAllHandler; +protected: + AsyncServer _server; + std::list> _rewrites; + std::list> _handlers; + AsyncCallbackWebHandler *_catchAllHandler; - public: - AsyncWebServer(uint16_t port); - ~AsyncWebServer(); +public: + AsyncWebServer(uint16_t port); + ~AsyncWebServer(); - void begin(); - void end(); + void begin(); + void end(); #if ASYNC_TCP_SSL_ENABLED - void onSslFileRequest(AcSSlFileHandler cb, void* arg); - void beginSecure(const char* cert, const char* private_key_file, const char* password); + void onSslFileRequest(AcSSlFileHandler cb, void *arg); + void beginSecure(const char *cert, const char *private_key_file, const char *password); #endif - AsyncWebRewrite& addRewrite(AsyncWebRewrite* rewrite); + AsyncWebRewrite &addRewrite(AsyncWebRewrite *rewrite); - /** + /** * @brief (compat) Add url rewrite rule by pointer * a deep copy of the pointer object will be created, * it is up to user to manage further lifetime of the object in argument @@ -844,18 +1090,18 @@ class AsyncWebServer : public AsyncMiddlewareChain { * @param rewrite pointer to rewrite object to copy setting from * @return AsyncWebRewrite& reference to a newly created rewrite rule */ - AsyncWebRewrite& addRewrite(std::shared_ptr rewrite); + AsyncWebRewrite &addRewrite(std::shared_ptr rewrite); - /** + /** * @brief add url rewrite rule * * @param from * @param to * @return AsyncWebRewrite& */ - AsyncWebRewrite& rewrite(const char* from, const char* to); + AsyncWebRewrite &rewrite(const char *from, const char *to); - /** + /** * @brief (compat) remove rewrite rule via referenced object * this will NOT deallocate pointed object itself, internal rule with same from/to urls will be removed if any * it's a compat method, better use `removeRewrite(const char* from, const char* to)` @@ -863,9 +1109,9 @@ class AsyncWebServer : public AsyncMiddlewareChain { * @return true * @return false */ - bool removeRewrite(AsyncWebRewrite* rewrite); + bool removeRewrite(AsyncWebRewrite *rewrite); - /** + /** * @brief remove rewrite rule * * @param from @@ -873,50 +1119,61 @@ class AsyncWebServer : public AsyncMiddlewareChain { * @return true * @return false */ - bool removeRewrite(const char* from, const char* to); + bool removeRewrite(const char *from, const char *to); - AsyncWebHandler& addHandler(AsyncWebHandler* handler); - bool removeHandler(AsyncWebHandler* handler); + AsyncWebHandler &addHandler(AsyncWebHandler *handler); + bool removeHandler(AsyncWebHandler *handler); - AsyncCallbackWebHandler& on(const char* uri, ArRequestHandlerFunction onRequest) { return on(uri, HTTP_ANY, onRequest); } - AsyncCallbackWebHandler& on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload = nullptr, ArBodyHandlerFunction onBody = nullptr); + AsyncCallbackWebHandler &on(const char *uri, ArRequestHandlerFunction onRequest) { + return on(uri, HTTP_ANY, onRequest); + } + AsyncCallbackWebHandler &on( + const char *uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload = nullptr, + ArBodyHandlerFunction onBody = nullptr + ); - AsyncStaticWebHandler& serveStatic(const char* uri, fs::FS& fs, const char* path, const char* cache_control = NULL); + AsyncStaticWebHandler &serveStatic(const char *uri, fs::FS &fs, const char *path, const char *cache_control = NULL); - void onNotFound(ArRequestHandlerFunction fn); // called when handler is not assigned - void onFileUpload(ArUploadHandlerFunction fn); // handle file uploads - void onRequestBody(ArBodyHandlerFunction fn); // handle posts with plain body content (JSON often transmitted this way as a request) + void onNotFound(ArRequestHandlerFunction fn); // called when handler is not assigned + void onFileUpload(ArUploadHandlerFunction fn); // handle file uploads + void onRequestBody(ArBodyHandlerFunction fn); // handle posts with plain body content (JSON often transmitted this way as a request) + // give access to the handler used to catch all requests, so that middleware can be added to it + AsyncWebHandler &catchAllHandler() const; - void reset(); // remove all writers and handlers, with onNotFound/onFileUpload/onRequestBody + void reset(); // remove all writers and handlers, with onNotFound/onFileUpload/onRequestBody - void _handleDisconnect(AsyncWebServerRequest* request); - void _attachHandler(AsyncWebServerRequest* request); - void _rewriteRequest(AsyncWebServerRequest* request); + void _handleDisconnect(AsyncWebServerRequest *request); + void _attachHandler(AsyncWebServerRequest *request); + void _rewriteRequest(AsyncWebServerRequest *request); }; class DefaultHeaders { - using headers_t = std::list; - headers_t _headers; + using headers_t = std::list; + headers_t _headers; - public: - DefaultHeaders() = default; +public: + DefaultHeaders() = default; - using ConstIterator = headers_t::const_iterator; + using ConstIterator = headers_t::const_iterator; - void addHeader(const String& name, const String& value) { - _headers.emplace_back(name, value); - } + void addHeader(const String &name, const String &value) { + _headers.emplace_back(name, value); + } - ConstIterator begin() const { return _headers.begin(); } - ConstIterator end() const { return _headers.end(); } + ConstIterator begin() const { + return _headers.begin(); + } + ConstIterator end() const { + return _headers.end(); + } - DefaultHeaders(DefaultHeaders const&) = delete; - DefaultHeaders& operator=(DefaultHeaders const&) = delete; + DefaultHeaders(DefaultHeaders const &) = delete; + DefaultHeaders &operator=(DefaultHeaders const &) = delete; - static DefaultHeaders& Instance() { - static DefaultHeaders instance; - return instance; - } + static DefaultHeaders &Instance() { + static DefaultHeaders instance; + return instance; + } }; #include "AsyncEventSource.h" diff --git a/src/Middleware.cpp b/src/Middleware.cpp index 1eb8e50..890303d 100644 --- a/src/Middleware.cpp +++ b/src/Middleware.cpp @@ -1,70 +1,85 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #include "WebAuthentication.h" #include AsyncMiddlewareChain::~AsyncMiddlewareChain() { - for (AsyncMiddleware* m : _middlewares) - if (m->_freeOnRemoval) + for (AsyncMiddleware *m : _middlewares) { + if (m->_freeOnRemoval) { delete m; + } + } } void AsyncMiddlewareChain::addMiddleware(ArMiddlewareCallback fn) { - AsyncMiddlewareFunction* m = new AsyncMiddlewareFunction(fn); + AsyncMiddlewareFunction *m = new AsyncMiddlewareFunction(fn); m->_freeOnRemoval = true; _middlewares.emplace_back(m); } -void AsyncMiddlewareChain::addMiddleware(AsyncMiddleware* middleware) { - if (middleware) +void AsyncMiddlewareChain::addMiddleware(AsyncMiddleware *middleware) { + if (middleware) { _middlewares.emplace_back(middleware); + } } -void AsyncMiddlewareChain::addMiddlewares(std::vector middlewares) { - for (AsyncMiddleware* m : middlewares) +void AsyncMiddlewareChain::addMiddlewares(std::vector middlewares) { + for (AsyncMiddleware *m : middlewares) { addMiddleware(m); + } } -bool AsyncMiddlewareChain::removeMiddleware(AsyncMiddleware* middleware) { +bool AsyncMiddlewareChain::removeMiddleware(AsyncMiddleware *middleware) { // remove all middlewares from _middlewares vector being equal to middleware, delete them having _freeOnRemoval flag to true and resize the vector. const size_t size = _middlewares.size(); - _middlewares.erase(std::remove_if(_middlewares.begin(), _middlewares.end(), [middleware](AsyncMiddleware* m) { - if (m == middleware) { - if (m->_freeOnRemoval) - delete m; - return true; - } - return false; - }), - _middlewares.end()); + _middlewares.erase( + std::remove_if( + _middlewares.begin(), _middlewares.end(), + [middleware](AsyncMiddleware *m) { + if (m == middleware) { + if (m->_freeOnRemoval) { + delete m; + } + return true; + } + return false; + } + ), + _middlewares.end() + ); return size != _middlewares.size(); } -void AsyncMiddlewareChain::_runChain(AsyncWebServerRequest* request, ArMiddlewareNext finalizer) { - if (!_middlewares.size()) +void AsyncMiddlewareChain::_runChain(AsyncWebServerRequest *request, ArMiddlewareNext finalizer) { + if (!_middlewares.size()) { return finalizer(); + } ArMiddlewareNext next; - std::list::iterator it = _middlewares.begin(); + std::list::iterator it = _middlewares.begin(); next = [this, &next, &it, request, finalizer]() { - if (it == _middlewares.end()) + if (it == _middlewares.end()) { return finalizer(); - AsyncMiddleware* m = *it; + } + AsyncMiddleware *m = *it; it++; return m->run(request, next); }; return next(); } -void AsyncAuthenticationMiddleware::setUsername(const char* username) { +void AsyncAuthenticationMiddleware::setUsername(const char *username) { _username = username; _hasCreds = _username.length() && _credentials.length(); } -void AsyncAuthenticationMiddleware::setPassword(const char* password) { +void AsyncAuthenticationMiddleware::setPassword(const char *password) { _credentials = password; _hash = false; _hasCreds = _username.length() && _credentials.length(); } -void AsyncAuthenticationMiddleware::setPasswordHash(const char* hash) { +void AsyncAuthenticationMiddleware::setPasswordHash(const char *hash) { _credentials = hash; _hash = _credentials.length(); _hasCreds = _username.length() && _credentials.length(); @@ -72,71 +87,86 @@ void AsyncAuthenticationMiddleware::setPasswordHash(const char* hash) { bool AsyncAuthenticationMiddleware::generateHash() { // ensure we have all the necessary data - if (!_hasCreds) + if (!_hasCreds) { return false; + } // if we already have a hash, do nothing - if (_hash) + if (_hash) { return false; + } switch (_authMethod) { case AsyncAuthType::AUTH_DIGEST: _credentials = generateDigestHash(_username.c_str(), _credentials.c_str(), _realm.c_str()); - _hash = true; - return true; + if (_credentials.length()) { + _hash = true; + return true; + } else { + return false; + } case AsyncAuthType::AUTH_BASIC: _credentials = generateBasicHash(_username.c_str(), _credentials.c_str()); - _hash = true; - return true; + if (_credentials.length()) { + _hash = true; + return true; + } else { + return false; + } - default: - return false; + default: return false; } } -bool AsyncAuthenticationMiddleware::allowed(AsyncWebServerRequest* request) const { - if (_authMethod == AsyncAuthType::AUTH_NONE) +bool AsyncAuthenticationMiddleware::allowed(AsyncWebServerRequest *request) const { + if (_authMethod == AsyncAuthType::AUTH_NONE) { return true; + } - if (_authMethod == AsyncAuthType::AUTH_DENIED) + if (_authMethod == AsyncAuthType::AUTH_DENIED) { return false; + } - if (!_hasCreds) + if (!_hasCreds) { return true; + } return request->authenticate(_username.c_str(), _credentials.c_str(), _realm.c_str(), _hash); } -void AsyncAuthenticationMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext next) { +void AsyncAuthenticationMiddleware::run(AsyncWebServerRequest *request, ArMiddlewareNext next) { return allowed(request) ? next() : request->requestAuthentication(_authMethod, _realm.c_str(), _authFailMsg.c_str()); } -void AsyncHeaderFreeMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext next) { - std::vector reqHeaders; - request->getHeaderNames(reqHeaders); - for (const char* h : reqHeaders) { +void AsyncHeaderFreeMiddleware::run(AsyncWebServerRequest *request, ArMiddlewareNext next) { + std::list toRemove; + for (auto &h : request->getHeaders()) { bool keep = false; - for (const char* k : _toKeep) { - if (strcasecmp(h, k) == 0) { + for (const char *k : _toKeep) { + if (strcasecmp(h.name().c_str(), k) == 0) { keep = true; break; } } if (!keep) { - request->removeHeader(h); + toRemove.push_back(h.name().c_str()); } } + for (const char *h : toRemove) { + request->removeHeader(h); + } next(); } -void AsyncHeaderFilterMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext next) { - for (auto it = _toRemove.begin(); it != _toRemove.end(); ++it) +void AsyncHeaderFilterMiddleware::run(AsyncWebServerRequest *request, ArMiddlewareNext next) { + for (auto it = _toRemove.begin(); it != _toRemove.end(); ++it) { request->removeHeader(*it); + } next(); } -void AsyncLoggingMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext next) { +void AsyncLoggingMiddleware::run(AsyncWebServerRequest *request, ArMiddlewareNext next) { if (!isEnabled()) { next(); return; @@ -152,7 +182,7 @@ void AsyncLoggingMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNex _out->print(request->url().c_str()); _out->print(F(" HTTP/1.")); _out->println(request->version()); - for (auto& h : request->getHeaders()) { + for (auto &h : request->getHeaders()) { if (h.value().length()) { _out->print('>'); _out->print(' '); @@ -166,7 +196,7 @@ void AsyncLoggingMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNex uint32_t elapsed = millis(); next(); elapsed = millis() - elapsed; - AsyncWebServerResponse* response = request->getResponse(); + AsyncWebServerResponse *response = request->getResponse(); if (response) { _out->print(F("* Processed in ")); _out->print(elapsed); @@ -178,7 +208,7 @@ void AsyncLoggingMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNex _out->print(response->code()); _out->print(' '); _out->println(AsyncWebServerResponse::responseCodeToString(response->code())); - for (auto& h : response->getHeaders()) { + for (auto &h : response->getHeaders()) { if (h.value().length()) { _out->print('<'); _out->print(' '); @@ -194,7 +224,7 @@ void AsyncLoggingMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNex } } -void AsyncCorsMiddleware::addCORSHeaders(AsyncWebServerResponse* response) { +void AsyncCorsMiddleware::addCORSHeaders(AsyncWebServerResponse *response) { response->addHeader(asyncsrv::T_CORS_ACAO, _origin.c_str()); response->addHeader(asyncsrv::T_CORS_ACAM, _methods.c_str()); response->addHeader(asyncsrv::T_CORS_ACAH, _headers.c_str()); @@ -202,12 +232,12 @@ void AsyncCorsMiddleware::addCORSHeaders(AsyncWebServerResponse* response) { response->addHeader(asyncsrv::T_CORS_ACMA, String(_maxAge).c_str()); } -void AsyncCorsMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext next) { +void AsyncCorsMiddleware::run(AsyncWebServerRequest *request, ArMiddlewareNext next) { // Origin header ? => CORS handling if (request->hasHeader(asyncsrv::T_CORS_O)) { // check if this is a preflight request => handle it and return if (request->method() == HTTP_OPTIONS) { - AsyncWebServerResponse* response = request->beginResponse(200); + AsyncWebServerResponse *response = request->beginResponse(200); addCORSHeaders(response); request->send(response); return; @@ -215,7 +245,7 @@ void AsyncCorsMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext n // CORS request, no options => let the request pass and add CORS headers after next(); - AsyncWebServerResponse* response = request->getResponse(); + AsyncWebServerResponse *response = request->getResponse(); if (response) { addCORSHeaders(response); } @@ -226,11 +256,12 @@ void AsyncCorsMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext n } } -bool AsyncRateLimitMiddleware::isRequestAllowed(uint32_t& retryAfterSeconds) { +bool AsyncRateLimitMiddleware::isRequestAllowed(uint32_t &retryAfterSeconds) { uint32_t now = millis(); - while (!_requestTimes.empty() && _requestTimes.front() <= now - _windowSizeMillis) + while (!_requestTimes.empty() && _requestTimes.front() <= now - _windowSizeMillis) { _requestTimes.pop_front(); + } _requestTimes.push_back(now); @@ -244,12 +275,12 @@ bool AsyncRateLimitMiddleware::isRequestAllowed(uint32_t& retryAfterSeconds) { return true; } -void AsyncRateLimitMiddleware::run(AsyncWebServerRequest* request, ArMiddlewareNext next) { +void AsyncRateLimitMiddleware::run(AsyncWebServerRequest *request, ArMiddlewareNext next) { uint32_t retryAfterSeconds; if (isRequestAllowed(retryAfterSeconds)) { next(); } else { - AsyncWebServerResponse* response = request->beginResponse(429); + AsyncWebServerResponse *response = request->beginResponse(429); response->addHeader(asyncsrv::T_retry_after, retryAfterSeconds); request->send(response); } diff --git a/src/WebAuthentication.cpp b/src/WebAuthentication.cpp index ebcc38e..7ed7814 100644 --- a/src/WebAuthentication.cpp +++ b/src/WebAuthentication.cpp @@ -1,29 +1,12 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #include "WebAuthentication.h" #include -#if defined(ESP32) || defined(TARGET_RP2040) - #include +#if defined(ESP32) || defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) +#include #else - #include "md5.h" +#include "md5.h" #endif #include "literals.h" @@ -31,23 +14,25 @@ using namespace asyncsrv; // Basic Auth hash = base64("username:password") -bool checkBasicAuthentication(const char* hash, const char* username, const char* password) { - if (username == NULL || password == NULL || hash == NULL) +bool checkBasicAuthentication(const char *hash, const char *username, const char *password) { + if (username == NULL || password == NULL || hash == NULL) { return false; + } return generateBasicHash(username, password).equalsIgnoreCase(hash); } -String generateBasicHash(const char* username, const char* password) { - if (username == NULL || password == NULL) +String generateBasicHash(const char *username, const char *password) { + if (username == NULL || password == NULL) { return emptyString; + } size_t toencodeLen = strlen(username) + strlen(password) + 1; - char* toencode = new char[toencodeLen + 1]; + char *toencode = new char[toencodeLen + 1]; if (toencode == NULL) { return emptyString; } - char* encoded = new char[base64_encode_expected_len(toencodeLen) + 1]; + char *encoded = new char[base64_encode_expected_len(toencodeLen) + 1]; if (encoded == NULL) { delete[] toencode; return emptyString; @@ -64,8 +49,8 @@ String generateBasicHash(const char* username, const char* password) { return emptyString; } -static bool getMD5(uint8_t* data, uint16_t len, char* output) { // 33 bytes or more -#if defined(ESP32) || defined(TARGET_RP2040) +static bool getMD5(uint8_t *data, uint16_t len, char *output) { // 33 bytes or more +#if defined(ESP32) || defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) MD5Builder md5; md5.begin(); md5.add(data, len); @@ -74,9 +59,10 @@ static bool getMD5(uint8_t* data, uint16_t len, char* output) { // 33 bytes or m #else md5_context_t _ctx; - uint8_t* _buf = (uint8_t*)malloc(16); - if (_buf == NULL) + uint8_t *_buf = (uint8_t *)malloc(16); + if (_buf == NULL) { return false; + } memset(_buf, 0x00, 16); MD5Init(&_ctx); @@ -98,49 +84,77 @@ String genRandomMD5() { #else uint32_t r = rand(); #endif - char* out = (char*)malloc(33); - if (out == NULL || !getMD5((uint8_t*)(&r), 4, out)) + char *out = (char *)malloc(33); + if (out == NULL || !getMD5((uint8_t *)(&r), 4, out)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif return emptyString; + } String res = String(out); free(out); return res; } -static String stringMD5(const String& in) { - char* out = (char*)malloc(33); - if (out == NULL || !getMD5((uint8_t*)(in.c_str()), in.length(), out)) +static String stringMD5(const String &in) { + char *out = (char *)malloc(33); + if (out == NULL || !getMD5((uint8_t *)(in.c_str()), in.length(), out)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif return emptyString; + } String res = String(out); free(out); return res; } -String generateDigestHash(const char* username, const char* password, const char* realm) { +String generateDigestHash(const char *username, const char *password, const char *realm) { if (username == NULL || password == NULL || realm == NULL) { return emptyString; } - char* out = (char*)malloc(33); + char *out = (char *)malloc(33); + if (out == NULL) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + return emptyString; + } String in; - in.reserve(strlen(username) + strlen(realm) + strlen(password) + 2); + if (!in.reserve(strlen(username) + strlen(realm) + strlen(password) + 2)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + free(out); + return emptyString; + } + in.concat(username); in.concat(':'); in.concat(realm); in.concat(':'); in.concat(password); - if (out == NULL || !getMD5((uint8_t*)(in.c_str()), in.length(), out)) + if (!getMD5((uint8_t *)(in.c_str()), in.length(), out)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + free(out); return emptyString; + } in = String(out); free(out); return in; } -bool checkDigestAuthentication(const char* header, const char* method, const char* username, const char* password, const char* realm, bool passwordIsHash, const char* nonce, const char* opaque, const char* uri) -{ +bool checkDigestAuthentication( + const char *header, const char *method, const char *username, const char *password, const char *realm, bool passwordIsHash, const char *nonce, + const char *opaque, const char *uri +) { if (username == NULL || password == NULL || header == NULL || method == NULL) { - // os_printf("AUTH FAIL: missing requred fields\n"); + // os_printf("AUTH FAIL: missing required fields\n"); return false; } @@ -160,8 +174,8 @@ bool checkDigestAuthentication(const char* header, const char* method, const cha String myNc; String myCnonce; - myHeader += (char)0x2c; // ',' - myHeader += (char)0x20; // ' ' + myHeader += (char)0x2c; // ',' + myHeader += (char)0x20; // ' ' do { String avLine(myHeader.substring(0, nextBreak)); avLine.trim(); diff --git a/src/WebAuthentication.h b/src/WebAuthentication.h index 68bed0c..1711821 100644 --- a/src/WebAuthentication.h +++ b/src/WebAuthentication.h @@ -1,37 +1,22 @@ -/* - Asynchronous WebServer library for Espressif MCUs - - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov #ifndef WEB_AUTHENTICATION_H_ #define WEB_AUTHENTICATION_H_ #include "Arduino.h" -bool checkBasicAuthentication(const char* header, const char* username, const char* password); +bool checkBasicAuthentication(const char *header, const char *username, const char *password); -bool checkDigestAuthentication(const char* header, const char* method, const char* username, const char* password, const char* realm, bool passwordIsHash, const char* nonce, const char* opaque, const char* uri); +bool checkDigestAuthentication( + const char *header, const char *method, const char *username, const char *password, const char *realm, bool passwordIsHash, const char *nonce, + const char *opaque, const char *uri +); // for storing hashed versions on the device that can be authenticated against -String generateDigestHash(const char* username, const char* password, const char* realm); +String generateDigestHash(const char *username, const char *password, const char *realm); -String generateBasicHash(const char* username, const char* password); +String generateBasicHash(const char *username, const char *password); String genRandomMD5(); diff --git a/src/WebHandlerImpl.h b/src/WebHandlerImpl.h index 134006f..99a9111 100644 --- a/src/WebHandlerImpl.h +++ b/src/WebHandlerImpl.h @@ -1,101 +1,94 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #ifndef ASYNCWEBSERVERHANDLERIMPL_H_ #define ASYNCWEBSERVERHANDLERIMPL_H_ #include #ifdef ASYNCWEBSERVER_REGEX - #include +#include #endif #include "stddef.h" #include class AsyncStaticWebHandler : public AsyncWebHandler { - using File = fs::File; - using FS = fs::FS; + using File = fs::File; + using FS = fs::FS; - private: - bool _getFile(AsyncWebServerRequest* request) const; - bool _searchFile(AsyncWebServerRequest* request, const String& path); - uint8_t _countBits(const uint8_t value) const; +private: + bool _getFile(AsyncWebServerRequest *request) const; + bool _searchFile(AsyncWebServerRequest *request, const String &path); + uint8_t _countBits(const uint8_t value) const; - protected: - FS _fs; - String _uri; - String _path; - String _default_file; - String _cache_control; - String _last_modified; - AwsTemplateProcessor _callback; - bool _isDir; - bool _tryGzipFirst = true; +protected: + FS _fs; + String _uri; + String _path; + String _default_file; + String _cache_control; + String _last_modified; + AwsTemplateProcessor _callback; + bool _isDir; + bool _tryGzipFirst = true; - public: - AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control); - bool canHandle(AsyncWebServerRequest* request) const override final; - void handleRequest(AsyncWebServerRequest* request) override final; - AsyncStaticWebHandler& setTryGzipFirst(bool value); - AsyncStaticWebHandler& setIsDir(bool isDir); - AsyncStaticWebHandler& setDefaultFile(const char* filename); - AsyncStaticWebHandler& setCacheControl(const char* cache_control); +public: + AsyncStaticWebHandler(const char *uri, FS &fs, const char *path, const char *cache_control); + bool canHandle(AsyncWebServerRequest *request) const override final; + void handleRequest(AsyncWebServerRequest *request) override final; + AsyncStaticWebHandler &setTryGzipFirst(bool value); + AsyncStaticWebHandler &setIsDir(bool isDir); + AsyncStaticWebHandler &setDefaultFile(const char *filename); + AsyncStaticWebHandler &setCacheControl(const char *cache_control); - /** + /** * @brief Set the Last-Modified time for the object - * - * @param last_modified - * @return AsyncStaticWebHandler& + * + * @param last_modified + * @return AsyncStaticWebHandler& */ - AsyncStaticWebHandler& setLastModified(const char* last_modified); - AsyncStaticWebHandler& setLastModified(struct tm* last_modified); - AsyncStaticWebHandler& setLastModified(time_t last_modified); - // sets to current time. Make sure sntp is runing and time is updated - AsyncStaticWebHandler& setLastModified(); + AsyncStaticWebHandler &setLastModified(const char *last_modified); + AsyncStaticWebHandler &setLastModified(struct tm *last_modified); + AsyncStaticWebHandler &setLastModified(time_t last_modified); + // sets to current time. Make sure sntp is running and time is updated + AsyncStaticWebHandler &setLastModified(); - AsyncStaticWebHandler& setTemplateProcessor(AwsTemplateProcessor newCallback); + AsyncStaticWebHandler &setTemplateProcessor(AwsTemplateProcessor newCallback); }; class AsyncCallbackWebHandler : public AsyncWebHandler { - private: - protected: - String _uri; - WebRequestMethodComposite _method; - ArRequestHandlerFunction _onRequest; - ArUploadHandlerFunction _onUpload; - ArBodyHandlerFunction _onBody; - bool _isRegex; +private: +protected: + String _uri; + WebRequestMethodComposite _method; + ArRequestHandlerFunction _onRequest; + ArUploadHandlerFunction _onUpload; + ArBodyHandlerFunction _onBody; + bool _isRegex; - public: - AsyncCallbackWebHandler() : _uri(), _method(HTTP_ANY), _onRequest(NULL), _onUpload(NULL), _onBody(NULL), _isRegex(false) {} - void setUri(const String& uri); - void setMethod(WebRequestMethodComposite method) { _method = method; } - void onRequest(ArRequestHandlerFunction fn) { _onRequest = fn; } - void onUpload(ArUploadHandlerFunction fn) { _onUpload = fn; } - void onBody(ArBodyHandlerFunction fn) { _onBody = fn; } +public: + AsyncCallbackWebHandler() : _uri(), _method(HTTP_ANY), _onRequest(NULL), _onUpload(NULL), _onBody(NULL), _isRegex(false) {} + void setUri(const String &uri); + void setMethod(WebRequestMethodComposite method) { + _method = method; + } + void onRequest(ArRequestHandlerFunction fn) { + _onRequest = fn; + } + void onUpload(ArUploadHandlerFunction fn) { + _onUpload = fn; + } + void onBody(ArBodyHandlerFunction fn) { + _onBody = fn; + } - bool canHandle(AsyncWebServerRequest* request) const override final; - void handleRequest(AsyncWebServerRequest* request) override final; - void handleUpload(AsyncWebServerRequest* request, const String& filename, size_t index, uint8_t* data, size_t len, bool final) override final; - void handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) override final; - bool isRequestHandlerTrivial() const override final { return !_onRequest; } + bool canHandle(AsyncWebServerRequest *request) const override final; + void handleRequest(AsyncWebServerRequest *request) override final; + void handleUpload(AsyncWebServerRequest *request, const String &filename, size_t index, uint8_t *data, size_t len, bool final) override final; + void handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) override final; + bool isRequestHandlerTrivial() const override final { + return !_onRequest; + } }; #endif /* ASYNCWEBSERVERHANDLERIMPL_H_ */ diff --git a/src/WebHandlers.cpp b/src/WebHandlers.cpp index 44a4601..516ffc2 100644 --- a/src/WebHandlers.cpp +++ b/src/WebHandlers.cpp @@ -1,33 +1,16 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #include "ESPAsyncWebServer.h" #include "WebHandlerImpl.h" using namespace asyncsrv; -AsyncWebHandler& AsyncWebHandler::setFilter(ArRequestFilterFunction fn) { +AsyncWebHandler &AsyncWebHandler::setFilter(ArRequestFilterFunction fn) { _filter = fn; return *this; } -AsyncWebHandler& AsyncWebHandler::setAuthentication(const char* username, const char* password, AsyncAuthType authMethod) { +AsyncWebHandler &AsyncWebHandler::setAuthentication(const char *username, const char *password, AsyncAuthType authMethod) { if (!_authMiddleware) { _authMiddleware = new AsyncAuthenticationMiddleware(); _authMiddleware->_freeOnRemoval = true; @@ -39,13 +22,15 @@ AsyncWebHandler& AsyncWebHandler::setAuthentication(const char* username, const return *this; }; -AsyncStaticWebHandler::AsyncStaticWebHandler(const char* uri, FS& fs, const char* path, const char* cache_control) - : _fs(fs), _uri(uri), _path(path), _default_file(F("index.htm")), _cache_control(cache_control), _last_modified(), _callback(nullptr) { +AsyncStaticWebHandler::AsyncStaticWebHandler(const char *uri, FS &fs, const char *path, const char *cache_control) + : _fs(fs), _uri(uri), _path(path), _default_file(F("index.htm")), _cache_control(cache_control), _last_modified(), _callback(nullptr) { // Ensure leading '/' - if (_uri.length() == 0 || _uri[0] != '/') + if (_uri.length() == 0 || _uri[0] != '/') { _uri = String('/') + _uri; - if (_path.length() == 0 || _path[0] != '/') + } + if (_path.length() == 0 || _path[0] != '/') { _path = String('/') + _path; + } // If path ends with '/' we assume a hint that this is a directory to improve performance. // However - if it does not end with '/' we, can't assume a file, path can still be a directory. @@ -53,45 +38,47 @@ AsyncStaticWebHandler::AsyncStaticWebHandler(const char* uri, FS& fs, const char // Remove the trailing '/' so we can handle default file // Notice that root will be "" not "/" - if (_uri[_uri.length() - 1] == '/') + if (_uri[_uri.length() - 1] == '/') { _uri = _uri.substring(0, _uri.length() - 1); - if (_path[_path.length() - 1] == '/') + } + if (_path[_path.length() - 1] == '/') { _path = _path.substring(0, _path.length() - 1); + } } -AsyncStaticWebHandler& AsyncStaticWebHandler::setTryGzipFirst(bool value) { +AsyncStaticWebHandler &AsyncStaticWebHandler::setTryGzipFirst(bool value) { _tryGzipFirst = value; return *this; } -AsyncStaticWebHandler& AsyncStaticWebHandler::setIsDir(bool isDir) { +AsyncStaticWebHandler &AsyncStaticWebHandler::setIsDir(bool isDir) { _isDir = isDir; return *this; } -AsyncStaticWebHandler& AsyncStaticWebHandler::setDefaultFile(const char* filename) { +AsyncStaticWebHandler &AsyncStaticWebHandler::setDefaultFile(const char *filename) { _default_file = filename; return *this; } -AsyncStaticWebHandler& AsyncStaticWebHandler::setCacheControl(const char* cache_control) { +AsyncStaticWebHandler &AsyncStaticWebHandler::setCacheControl(const char *cache_control) { _cache_control = cache_control; return *this; } -AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(const char* last_modified) { +AsyncStaticWebHandler &AsyncStaticWebHandler::setLastModified(const char *last_modified) { _last_modified = last_modified; return *this; } -AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(struct tm* last_modified) { +AsyncStaticWebHandler &AsyncStaticWebHandler::setLastModified(struct tm *last_modified) { char result[30]; #ifdef ESP8266 auto formatP = PSTR("%a, %d %b %Y %H:%M:%S GMT"); char format[strlen_P(formatP) + 1]; strcpy_P(format, formatP); #else - static constexpr const char* format = "%a, %d %b %Y %H:%M:%S GMT"; + static constexpr const char *format = "%a, %d %b %Y %H:%M:%S GMT"; #endif strftime(result, sizeof(result), format, last_modified); @@ -99,22 +86,23 @@ AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(struct tm* last_mo return *this; } -AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified(time_t last_modified) { - return setLastModified((struct tm*)gmtime(&last_modified)); +AsyncStaticWebHandler &AsyncStaticWebHandler::setLastModified(time_t last_modified) { + return setLastModified((struct tm *)gmtime(&last_modified)); } -AsyncStaticWebHandler& AsyncStaticWebHandler::setLastModified() { +AsyncStaticWebHandler &AsyncStaticWebHandler::setLastModified() { time_t last_modified; - if (time(&last_modified) == 0) // time is not yet set + if (time(&last_modified) == 0) { // time is not yet set return *this; + } return setLastModified(last_modified); } -bool AsyncStaticWebHandler::canHandle(AsyncWebServerRequest* request) const { +bool AsyncStaticWebHandler::canHandle(AsyncWebServerRequest *request) const { return request->isHTTP() && request->method() == HTTP_GET && request->url().startsWith(_uri) && _getFile(request); } -bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest* request) const { +bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest *request) const { // Remove the found uri String path = request->url().substring(_uri.length()); @@ -124,28 +112,31 @@ bool AsyncStaticWebHandler::_getFile(AsyncWebServerRequest* request) const { path = _path + path; // Do we have a file or .gz file - if (!canSkipFileCheck && const_cast(this)->_searchFile(request, path)) + if (!canSkipFileCheck && const_cast(this)->_searchFile(request, path)) { return true; + } // Can't handle if not default file - if (_default_file.length() == 0) + if (_default_file.length() == 0) { return false; + } - // Try to add default file, ensure there is a trailing '/' ot the path. - if (path.length() == 0 || path[path.length() - 1] != '/') + // Try to add default file, ensure there is a trailing '/' to the path. + if (path.length() == 0 || path[path.length() - 1] != '/') { path += String('/'); + } path += _default_file; - return const_cast(this)->_searchFile(request, path); + return const_cast(this)->_searchFile(request, path); } #ifdef ESP32 - #define FILE_IS_REAL(f) (f == true && !f.isDirectory()) +#define FILE_IS_REAL(f) (f == true && !f.isDirectory()) #else - #define FILE_IS_REAL(f) (f == true) +#define FILE_IS_REAL(f) (f == true) #endif -bool AsyncStaticWebHandler::_searchFile(AsyncWebServerRequest* request, const String& path) { +bool AsyncStaticWebHandler::_searchFile(AsyncWebServerRequest *request, const String &path) { bool fileFound = false; bool gzipFound = false; @@ -180,9 +171,17 @@ bool AsyncStaticWebHandler::_searchFile(AsyncWebServerRequest* request, const St if (found) { // Extract the file name from the path and keep it in _tempObject size_t pathLen = path.length(); - char* _tempPath = (char*)malloc(pathLen + 1); + char *_tempPath = (char *)malloc(pathLen + 1); + if (_tempPath == NULL) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + request->abort(); + request->_tempFile.close(); + return false; + } snprintf_P(_tempPath, pathLen + 1, PSTR("%s"), path.c_str()); - request->_tempObject = (void*)_tempPath; + request->_tempObject = (void *)_tempPath; } return found; @@ -191,81 +190,97 @@ bool AsyncStaticWebHandler::_searchFile(AsyncWebServerRequest* request, const St uint8_t AsyncStaticWebHandler::_countBits(const uint8_t value) const { uint8_t w = value; uint8_t n; - for (n = 0; w != 0; n++) + for (n = 0; w != 0; n++) { w &= w - 1; + } return n; } -void AsyncStaticWebHandler::handleRequest(AsyncWebServerRequest* request) { +void AsyncStaticWebHandler::handleRequest(AsyncWebServerRequest *request) { // Get the filename from request->_tempObject and free it - String filename((char*)request->_tempObject); + String filename((char *)request->_tempObject); free(request->_tempObject); request->_tempObject = NULL; - if (request->_tempFile != true){ + if (request->_tempFile != true) { request->send(404); return; } - time_t lw = request->_tempFile.getLastWrite(); // get last file mod time (if supported by FS) - // set etag to lastmod timestamp if available, otherwise to size - String etag; - if (lw) { - setLastModified(lw); -#if defined(TARGET_RP2040) - // time_t == long long int - constexpr size_t len = 1 + 8 * sizeof(time_t); - char buf[len]; - char* ret = lltoa(lw ^ request->_tempFile.size(), buf, len, 10); - etag = ret ? String(ret) : String(request->_tempFile.size()); + time_t lw = request->_tempFile.getLastWrite(); // get last file mod time (if supported by FS) + // set etag to lastmod timestamp if available, otherwise to size + String etag; + if (lw) { + setLastModified(lw); +#if defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) + // time_t == long long int + constexpr size_t len = 1 + 8 * sizeof(time_t); + char buf[len]; + char *ret = lltoa(lw ^ request->_tempFile.size(), buf, len, 10); + etag = ret ? String(ret) : String(request->_tempFile.size()); #else - etag = lw ^ request->_tempFile.size(); // etag combines file size and lastmod timestamp + etag = lw ^ request->_tempFile.size(); // etag combines file size and lastmod timestamp #endif - } else { - etag = request->_tempFile.size(); - } + } else { +#if defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) + etag = String(request->_tempFile.size()); +#else + etag = request->_tempFile.size(); +#endif + } - bool not_modified = false; + bool not_modified = false; - // if-none-match has precedence over if-modified-since - if (request->hasHeader(T_INM)) - not_modified = request->header(T_INM).equals(etag); - else if (_last_modified.length()) - not_modified = request->header(T_IMS).equals(_last_modified); + // if-none-match has precedence over if-modified-since + if (request->hasHeader(T_INM)) { + not_modified = request->header(T_INM).equals(etag); + } else if (_last_modified.length()) { + not_modified = request->header(T_IMS).equals(_last_modified); + } - AsyncWebServerResponse* response; + AsyncWebServerResponse *response; - if (not_modified){ - request->_tempFile.close(); - response = new AsyncBasicResponse(304); // Not modified - } else { - response = new AsyncFileResponse(request->_tempFile, filename, emptyString, false, _callback); - } + if (not_modified) { + request->_tempFile.close(); + response = new AsyncBasicResponse(304); // Not modified + } else { + response = new AsyncFileResponse(request->_tempFile, filename, emptyString, false, _callback); + } - response->addHeader(T_ETag, etag.c_str()); + if (!response) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + request->abort(); + return; + } - if (_last_modified.length()) - response->addHeader(T_Last_Modified, _last_modified.c_str()); - if (_cache_control.length()) - response->addHeader(T_Cache_Control, _cache_control.c_str()); - - request->send(response); + response->addHeader(T_ETag, etag.c_str()); + if (_last_modified.length()) { + response->addHeader(T_Last_Modified, _last_modified.c_str()); + } + if (_cache_control.length()) { + response->addHeader(T_Cache_Control, _cache_control.c_str()); + } + + request->send(response); } -AsyncStaticWebHandler& AsyncStaticWebHandler::setTemplateProcessor(AwsTemplateProcessor newCallback) { +AsyncStaticWebHandler &AsyncStaticWebHandler::setTemplateProcessor(AwsTemplateProcessor newCallback) { _callback = newCallback; return *this; } -void AsyncCallbackWebHandler::setUri(const String& uri) { +void AsyncCallbackWebHandler::setUri(const String &uri) { _uri = uri; _isRegex = uri.startsWith("^") && uri.endsWith("$"); } -bool AsyncCallbackWebHandler::canHandle(AsyncWebServerRequest* request) const { - if (!_onRequest || !request->isHTTP() || !(_method & request->method())) +bool AsyncCallbackWebHandler::canHandle(AsyncWebServerRequest *request) const { + if (!_onRequest || !request->isHTTP() || !(_method & request->method())) { return false; + } #ifdef ASYNCWEBSERVER_REGEX if (_isRegex) { @@ -273,7 +288,7 @@ bool AsyncCallbackWebHandler::canHandle(AsyncWebServerRequest* request) const { std::smatch matches; std::string s(request->url().c_str()); if (std::regex_search(s, matches, pattern)) { - for (size_t i = 1; i < matches.size(); ++i) { // start from 1 + for (size_t i = 1; i < matches.size(); ++i) { // start from 1 request->_addPathParam(matches[i].str().c_str()); } } else { @@ -284,30 +299,37 @@ bool AsyncCallbackWebHandler::canHandle(AsyncWebServerRequest* request) const { if (_uri.length() && _uri.startsWith("/*.")) { String uriTemplate = String(_uri); uriTemplate = uriTemplate.substring(uriTemplate.lastIndexOf(".")); - if (!request->url().endsWith(uriTemplate)) + if (!request->url().endsWith(uriTemplate)) { return false; + } } else if (_uri.length() && _uri.endsWith("*")) { String uriTemplate = String(_uri); uriTemplate = uriTemplate.substring(0, uriTemplate.length() - 1); - if (!request->url().startsWith(uriTemplate)) + if (!request->url().startsWith(uriTemplate)) { return false; - } else if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/"))) + } + } else if (_uri.length() && (_uri != request->url() && !request->url().startsWith(_uri + "/"))) { return false; + } return true; } -void AsyncCallbackWebHandler::handleRequest(AsyncWebServerRequest* request) { - if (_onRequest) +void AsyncCallbackWebHandler::handleRequest(AsyncWebServerRequest *request) { + if (_onRequest) { _onRequest(request); - else - request->send(500); + } else { + request->send(404, T_text_plain, "Not found"); + } } -void AsyncCallbackWebHandler::handleUpload(AsyncWebServerRequest* request, const String& filename, size_t index, uint8_t* data, size_t len, bool final) { - if (_onUpload) +void AsyncCallbackWebHandler::handleUpload(AsyncWebServerRequest *request, const String &filename, size_t index, uint8_t *data, size_t len, bool final) { + if (_onUpload) { _onUpload(request, filename, index, data, len, final); + } } -void AsyncCallbackWebHandler::handleBody(AsyncWebServerRequest* request, uint8_t* data, size_t len, size_t index, size_t total) { - if (_onBody) +void AsyncCallbackWebHandler::handleBody(AsyncWebServerRequest *request, uint8_t *data, size_t len, size_t index, size_t total) { + // ESP_LOGD("AsyncWebServer", "AsyncCallbackWebHandler::handleBody"); + if (_onBody) { _onBody(request, data, len, index, total); -} \ No newline at end of file + } +} diff --git a/src/WebRequest.cpp b/src/WebRequest.cpp index e96ec5f..8b735af 100644 --- a/src/WebRequest.cpp +++ b/src/WebRequest.cpp @@ -1,23 +1,6 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #include "ESPAsyncWebServer.h" #include "WebAuthentication.h" #include "WebResponseImpl.h" @@ -26,30 +9,89 @@ #define __is_param_char(c) ((c) && ((c) != '{') && ((c) != '[') && ((c) != '&') && ((c) != '=')) +static void doNotDelete(AsyncWebServerRequest *) {} + using namespace asyncsrv; -enum { PARSE_REQ_START = 0, - PARSE_REQ_HEADERS = 1, - PARSE_REQ_BODY = 2, - PARSE_REQ_END = 3, - PARSE_REQ_FAIL = 4 }; +enum { + PARSE_REQ_START = 0, + PARSE_REQ_HEADERS = 1, + PARSE_REQ_BODY = 2, + PARSE_REQ_END = 3, + PARSE_REQ_FAIL = 4 +}; -AsyncWebServerRequest::AsyncWebServerRequest(AsyncWebServer* s, AsyncClient* c) - : _client(c), _server(s), _handler(NULL), _response(NULL), _temp(), _parseState(PARSE_REQ_START), _version(0), _method(HTTP_ANY), _url(), _host(), _contentType(), _boundary(), _authorization(), _reqconntype(RCT_HTTP), _authMethod(AsyncAuthType::AUTH_NONE), _isMultipart(false), _isPlainPost(false), _expectingContinue(false), _contentLength(0), _parsedLength(0), _multiParseState(0), _boundaryPosition(0), _itemStartIndex(0), _itemSize(0), _itemName(), _itemFilename(), _itemType(), _itemValue(), _itemBuffer(0), _itemBufferIndex(0), _itemIsFile(false), _tempObject(NULL) { - c->onError([](void* r, AsyncClient* c, int8_t error) { (void)c; AsyncWebServerRequest *req = (AsyncWebServerRequest*)r; req->_onError(error); }, this); - c->onAck([](void* r, AsyncClient* c, size_t len, uint32_t time) { (void)c; AsyncWebServerRequest *req = (AsyncWebServerRequest*)r; req->_onAck(len, time); }, this); - c->onDisconnect([](void* r, AsyncClient* c) { AsyncWebServerRequest *req = (AsyncWebServerRequest*)r; req->_onDisconnect(); delete c; }, this); - c->onTimeout([](void* r, AsyncClient* c, uint32_t time) { (void)c; AsyncWebServerRequest *req = (AsyncWebServerRequest*)r; req->_onTimeout(time); }, this); - c->onData([](void* r, AsyncClient* c, void* buf, size_t len) { (void)c; AsyncWebServerRequest *req = (AsyncWebServerRequest*)r; req->_onData(buf, len); }, this); - c->onPoll([](void* r, AsyncClient* c) { (void)c; AsyncWebServerRequest *req = ( AsyncWebServerRequest*)r; req->_onPoll(); }, this); +AsyncWebServerRequest::AsyncWebServerRequest(AsyncWebServer *s, AsyncClient *c) + : _client(c), _server(s), _handler(NULL), _response(NULL), _temp(), _parseState(PARSE_REQ_START), _version(0), _method(HTTP_ANY), _url(), _host(), + _contentType(), _boundary(), _authorization(), _reqconntype(RCT_HTTP), _authMethod(AsyncAuthType::AUTH_NONE), _isMultipart(false), _isPlainPost(false), + _expectingContinue(false), _contentLength(0), _parsedLength(0), _multiParseState(0), _boundaryPosition(0), _itemStartIndex(0), _itemSize(0), _itemName(), + _itemFilename(), _itemType(), _itemValue(), _itemBuffer(0), _itemBufferIndex(0), _itemIsFile(false), _tempObject(NULL) { + c->onError( + [](void *r, AsyncClient *c, int8_t error) { + (void)c; + // log_e("AsyncWebServerRequest::_onError"); + AsyncWebServerRequest *req = (AsyncWebServerRequest *)r; + req->_onError(error); + }, + this + ); + c->onAck( + [](void *r, AsyncClient *c, size_t len, uint32_t time) { + (void)c; + // log_e("AsyncWebServerRequest::_onAck"); + AsyncWebServerRequest *req = (AsyncWebServerRequest *)r; + req->_onAck(len, time); + }, + this + ); + c->onDisconnect( + [](void *r, AsyncClient *c) { + // log_e("AsyncWebServerRequest::_onDisconnect"); + AsyncWebServerRequest *req = (AsyncWebServerRequest *)r; + req->_onDisconnect(); + delete c; + }, + this + ); + c->onTimeout( + [](void *r, AsyncClient *c, uint32_t time) { + (void)c; + // log_e("AsyncWebServerRequest::_onTimeout"); + AsyncWebServerRequest *req = (AsyncWebServerRequest *)r; + req->_onTimeout(time); + }, + this + ); + c->onData( + [](void *r, AsyncClient *c, void *buf, size_t len) { + (void)c; + // log_e("AsyncWebServerRequest::_onData"); + AsyncWebServerRequest *req = (AsyncWebServerRequest *)r; + req->_onData(buf, len); + }, + this + ); + c->onPoll( + [](void *r, AsyncClient *c) { + (void)c; + // log_e("AsyncWebServerRequest::_onPoll"); + AsyncWebServerRequest *req = (AsyncWebServerRequest *)r; + req->_onPoll(); + }, + this + ); } AsyncWebServerRequest::~AsyncWebServerRequest() { + // log_e("AsyncWebServerRequest::~AsyncWebServerRequest"); + + _this.reset(); + _headers.clear(); _pathParams.clear(); - AsyncWebServerResponse* r = _response; + AsyncWebServerResponse *r = _response; _response = NULL; delete r; @@ -66,15 +108,15 @@ AsyncWebServerRequest::~AsyncWebServerRequest() { } } -void AsyncWebServerRequest::_onData(void* buf, size_t len) { +void AsyncWebServerRequest::_onData(void *buf, size_t len) { // SSL/TLS handshake detection #ifndef ASYNC_TCP_SSL_ENABLED - if (_parseState == PARSE_REQ_START && len && ((uint8_t*)buf)[0] == 0x16) { // 0x16 indicates a Handshake message (SSL/TLS). - #ifdef ESP32 + if (_parseState == PARSE_REQ_START && len && ((uint8_t *)buf)[0] == 0x16) { // 0x16 indicates a Handshake message (SSL/TLS). +#ifdef ESP32 log_d("SSL/TLS handshake detected: resetting connection"); - #endif +#endif _parseState = PARSE_REQ_FAIL; - _client->abort(); + abort(); return; } #endif @@ -84,26 +126,33 @@ void AsyncWebServerRequest::_onData(void* buf, size_t len) { if (_parseState < PARSE_REQ_BODY) { // Find new line in buf - char* str = (char*)buf; + char *str = (char *)buf; for (i = 0; i < len; i++) { // Check for null characters in header if (!str[i]) { _parseState = PARSE_REQ_FAIL; - _client->abort(); + abort(); return; } if (str[i] == '\n') { break; } } - if (i == len) { // No new line, just add the buffer in _temp + if (i == len) { // No new line, just add the buffer in _temp char ch = str[len - 1]; str[len - 1] = 0; - _temp.reserve(_temp.length() + len); + if (!_temp.reserve(_temp.length() + len)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + _parseState = PARSE_REQ_FAIL; + abort(); + return; + } _temp.concat(str); _temp.concat(ch); - } else { // Found new line - extract it and parse - str[i] = 0; // Terminate the string at the end of the line. + } else { // Found new line - extract it and parse + str[i] = 0; // Terminate the string at the end of the line. _temp.concat(str); _temp.trim(); _parseLine(); @@ -118,37 +167,41 @@ void AsyncWebServerRequest::_onData(void* buf, size_t len) { // A handler should be already attached at this point in _parseLine function. // If handler does nothing (_onRequest is NULL), we don't need to really parse the body. const bool needParse = _handler && !_handler->isRequestHandlerTrivial(); + // Discard any bytes after content length; handlers may overrun their buffers + len = std::min(len, _contentLength - _parsedLength); if (_isMultipart) { if (needParse) { size_t i; for (i = 0; i < len; i++) { - _parseMultipartPostByte(((uint8_t*)buf)[i], i == len - 1); + _parseMultipartPostByte(((uint8_t *)buf)[i], i == len - 1); _parsedLength++; } - } else + } else { _parsedLength += len; + } } else { if (_parsedLength == 0) { if (_contentType.startsWith(T_app_xform_urlencoded)) { _isPlainPost = true; - } else if (_contentType == T_text_plain && __is_param_char(((char*)buf)[0])) { + } else if (_contentType == T_text_plain && __is_param_char(((char *)buf)[0])) { size_t i = 0; - while (i < len && __is_param_char(((char*)buf)[i++])) - ; - if (i < len && ((char*)buf)[i - 1] == '=') { + while (i < len && __is_param_char(((char *)buf)[i++])); + if (i < len && ((char *)buf)[i - 1] == '=') { _isPlainPost = true; } } } if (!_isPlainPost) { - if (_handler) - _handler->handleBody(this, (uint8_t*)buf, len, _parsedLength, _contentLength); + // ESP_LOGD("AsyncWebServer", "_isPlainPost: %d, _handler: %p", _isPlainPost, _handler); + if (_handler) { + _handler->handleBody(this, (uint8_t *)buf, len, _parsedLength, _contentLength); + } _parsedLength += len; } else if (needParse) { size_t i; for (i = 0; i < len; i++) { _parsedLength++; - _parsePlainPostChar(((uint8_t*)buf)[i]); + _parsePlainPostChar(((uint8_t *)buf)[i]); } } else { _parsedLength += len; @@ -156,16 +209,8 @@ void AsyncWebServerRequest::_onData(void* buf, size_t len) { } if (_parsedLength == _contentLength) { _parseState = PARSE_REQ_END; - _server->_runChain(this, [this]() { return _handler ? _handler->_runChain(this, [this]() { _handler->handleRequest(this); }) : send(501); }); - if (!_sent) { - if (!_response) - send(501, T_text_plain, "Handler did not handle the request"); - else if (!_response->_sourceValid()) - send(500, T_text_plain, "Invalid data in handler"); - _client->setRxTimeout(0); - _response->_respond(this); - _sent = true; - } + _runMiddlewareChain(); + _send(); } } break; @@ -178,7 +223,7 @@ void AsyncWebServerRequest::_onPoll() { if (!_response->_finished()) { _response->_ack(this, 0, 0); } else { - AsyncWebServerResponse* r = _response; + AsyncWebServerResponse *r = _response; _response = NULL; delete r; @@ -193,7 +238,7 @@ void AsyncWebServerRequest::_onAck(size_t len, uint32_t time) { if (!_response->_finished()) { _response->_ack(this, len, time); } else if (_response->_finished()) { - AsyncWebServerResponse* r = _response; + AsyncWebServerResponse *r = _response; _response = NULL; delete r; @@ -224,22 +269,26 @@ void AsyncWebServerRequest::_onDisconnect() { _server->_handleDisconnect(this); } -void AsyncWebServerRequest::_addPathParam(const char* p) { +void AsyncWebServerRequest::_addPathParam(const char *p) { _pathParams.emplace_back(p); } -void AsyncWebServerRequest::_addGetParams(const String& params) { +void AsyncWebServerRequest::_addGetParams(const String ¶ms) { size_t start = 0; while (start < params.length()) { int end = params.indexOf('&', start); - if (end < 0) + if (end < 0) { end = params.length(); + } int equal = params.indexOf('=', start); - if (equal < 0 || equal > end) + if (equal < 0 || equal > end) { equal = end; - String name(params.substring(start, equal)); - String value(equal + 1 < end ? params.substring(equal + 1, end) : String()); - _params.emplace_back(urlDecode(name), urlDecode(value)); + } + String name = urlDecode(params.substring(start, equal)); + String value = urlDecode(equal + 1 < end ? params.substring(equal + 1, end) : emptyString); + if (name.length()) { + _params.emplace_back(name, value); + } start = end + 1; } } @@ -279,11 +328,13 @@ bool AsyncWebServerRequest::_parseReqHead() { _url = urlDecode(u); _addGetParams(g); - if (!_url.length()) + if (!_url.length()) { return false; + } - if (!_temp.startsWith(T_HTTP_1_0)) + if (!_temp.startsWith(T_HTTP_1_0)) { _version = 1; + } _temp = emptyString; return true; @@ -332,9 +383,9 @@ bool AsyncWebServerRequest::_parseReqHeader() { String lowcase(value); lowcase.toLowerCase(); #ifndef ESP8266 - const char* substr = std::strstr(lowcase.c_str(), T_text_event_stream); + const char *substr = std::strstr(lowcase.c_str(), T_text_event_stream); #else - const char* substr = std::strstr(lowcase.c_str(), String(T_text_event_stream).c_str()); + const char *substr = std::strstr(lowcase.c_str(), String(T_text_event_stream).c_str()); #endif if (substr != NULL) { // WebEvent request can be uniquely identified by header: [Accept: text/event-stream] @@ -343,18 +394,19 @@ bool AsyncWebServerRequest::_parseReqHeader() { } _headers.emplace_back(name, value); } -#ifndef TARGET_RP2040 - _temp.clear(); -#else +#if defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) // Ancient PRI core does not have String::clear() method 8-() _temp = emptyString; +#else + _temp.clear(); #endif return true; } void AsyncWebServerRequest::_parsePlainPostChar(uint8_t data) { - if (data && (char)data != '&') + if (data && (char)data != '&') { _temp += (char)data; + } if (!data || (char)data == '&' || _parsedLength == _contentLength) { String name(T_BODY); String value(_temp); @@ -362,13 +414,16 @@ void AsyncWebServerRequest::_parsePlainPostChar(uint8_t data) { name = _temp.substring(0, _temp.indexOf('=')); value = _temp.substring(_temp.indexOf('=') + 1); } - _params.emplace_back(urlDecode(name), urlDecode(value), true); + name = urlDecode(name); + if (name.length()) { + _params.emplace_back(name, urlDecode(value), true); + } -#ifndef TARGET_RP2040 - _temp.clear(); -#else +#if defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) // Ancient PRI core does not have String::clear() method 8-() _temp = emptyString; +#else + _temp.clear(); #endif } } @@ -378,8 +433,9 @@ void AsyncWebServerRequest::_handleUploadByte(uint8_t data, bool last) { if (last || _itemBufferIndex == RESPONSE_STREAM_BUFFER_SIZE) { // check if authenticated before calling the upload - if (_handler) + if (_handler) { _handler->handleUpload(this, _itemFilename, _itemSize - _itemBufferIndex, _itemBuffer, _itemBufferIndex, false); + } _itemBufferIndex = 0; } } @@ -441,8 +497,9 @@ void AsyncWebServerRequest::_parseMultipartPostByte(uint8_t data, bool last) { _itemIsFile = false; } } else if (_multiParseState == PARSE_HEADERS) { - if ((char)data != '\r' && (char)data != '\n') + if ((char)data != '\r' && (char)data != '\n') { _temp += (char)data; + } if ((char)data == '\n') { if (_temp.length()) { if (_temp.length() > 12 && _temp.substring(0, 12).equalsIgnoreCase(T_Content_Type)) { @@ -478,11 +535,16 @@ void AsyncWebServerRequest::_parseMultipartPostByte(uint8_t data, bool last) { _itemStartIndex = _parsedLength; _itemValue = emptyString; if (_itemIsFile) { - if (_itemBuffer) + if (_itemBuffer) { free(_itemBuffer); - _itemBuffer = (uint8_t*)malloc(RESPONSE_STREAM_BUFFER_SIZE); + } + _itemBuffer = (uint8_t *)malloc(RESPONSE_STREAM_BUFFER_SIZE); if (_itemBuffer == NULL) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif _multiParseState = PARSE_ERROR; + abort(); return; } _itemBufferIndex = 0; @@ -525,8 +587,9 @@ void AsyncWebServerRequest::_parseMultipartPostByte(uint8_t data, bool last) { itemWriteByte('-'); itemWriteByte('-'); uint8_t i; - for (i = 0; i < _boundaryPosition; i++) + for (i = 0; i < _boundaryPosition; i++) { itemWriteByte(_boundary.c_str()[i]); + } _parseMultipartPostByte(data, last); } else if (_boundaryPosition == _boundary.length() - 1) { _multiParseState = DASH3_OR_RETURN2; @@ -534,8 +597,9 @@ void AsyncWebServerRequest::_parseMultipartPostByte(uint8_t data, bool last) { _params.emplace_back(_itemName, _itemValue, true); } else { if (_itemSize) { - if (_handler) + if (_handler) { _handler->handleUpload(this, _itemFilename, _itemSize - _itemBufferIndex, _itemBuffer, _itemBufferIndex, true); + } _itemBufferIndex = 0; _params.emplace_back(_itemName, _itemFilename, true, true, _itemSize); } @@ -549,7 +613,7 @@ void AsyncWebServerRequest::_parseMultipartPostByte(uint8_t data, bool last) { } else if (_multiParseState == DASH3_OR_RETURN2) { if (data == '-' && (_contentLength - _parsedLength - 4) != 0) { // os_printf("ERROR: The parser got to the end of the POST but is expecting %u bytes more!\nDrop an issue so we can have more info on the matter!\n", _contentLength - _parsedLength - 4); - _contentLength = _parsedLength + 4; // lets close the request gracefully + _contentLength = _parsedLength + 4; // lets close the request gracefully } if (data == '\r') { _multiParseState = EXPECT_FEED2; @@ -562,8 +626,9 @@ void AsyncWebServerRequest::_parseMultipartPostByte(uint8_t data, bool last) { itemWriteByte('-'); itemWriteByte('-'); uint8_t i; - for (i = 0; i < _boundary.length(); i++) + for (i = 0; i < _boundary.length(); i++) { itemWriteByte(_boundary.c_str()[i]); + } _parseMultipartPostByte(data, last); } } else if (_multiParseState == EXPECT_FEED2) { @@ -577,8 +642,9 @@ void AsyncWebServerRequest::_parseMultipartPostByte(uint8_t data, bool last) { itemWriteByte('-'); itemWriteByte('-'); uint8_t i; - for (i = 0; i < _boundary.length(); i++) + for (i = 0; i < _boundary.length(); i++) { itemWriteByte(_boundary.c_str()[i]); + } itemWriteByte('\r'); _parseMultipartPostByte(data, last); } @@ -589,13 +655,13 @@ void AsyncWebServerRequest::_parseLine() { if (_parseState == PARSE_REQ_START) { if (!_temp.length()) { _parseState = PARSE_REQ_FAIL; - _client->abort(); + abort(); } else { if (_parseReqHead()) { _parseState = PARSE_REQ_HEADERS; } else { _parseState = PARSE_REQ_FAIL; - _client->abort(); + abort(); } } return; @@ -614,19 +680,71 @@ void AsyncWebServerRequest::_parseLine() { _parseState = PARSE_REQ_BODY; } else { _parseState = PARSE_REQ_END; - _server->_runChain(this, [this]() { return _handler ? _handler->_runChain(this, [this]() { _handler->handleRequest(this); }) : send(501); }); - if (!_sent) { - if (!_response) - send(501, T_text_plain, "Handler did not handle the request"); - else if (!_response->_sourceValid()) - send(500, T_text_plain, "Invalid data in handler"); - _client->setRxTimeout(0); - _response->_respond(this); - _sent = true; - } + _runMiddlewareChain(); + _send(); } - } else + } else { _parseReqHeader(); + } + } +} + +void AsyncWebServerRequest::_runMiddlewareChain() { + if (_handler && _handler->mustSkipServerMiddlewares()) { + _handler->_runChain(this, [this]() { + _handler->handleRequest(this); + }); + } else { + _server->_runChain(this, [this]() { + if (_handler) { + _handler->_runChain(this, [this]() { + _handler->handleRequest(this); + }); + } + }); + } +} + +void AsyncWebServerRequest::_send() { + if (!_sent && !_paused) { + // log_d("AsyncWebServerRequest::_send()"); + + // user did not create a response ? + if (!_response) { + send(501, T_text_plain, "Handler did not handle the request"); + } + + // response is not valid ? + if (!_response->_sourceValid()) { + send(500, T_text_plain, "Invalid data in handler"); + } + + // here, we either have a response give nfrom user or one of the two above + _client->setRxTimeout(0); + _response->_respond(this); + _sent = true; + } +} + +AsyncWebServerRequestPtr AsyncWebServerRequest::pause() { + if (_paused) { + return _this; + } + client()->setRxTimeout(0); + // this shared ptr will hold the request pointer until it gets destroyed following a disconnect. + // this is just used as a holder providing weak observers, so the deleter is a no-op. + _this = std::shared_ptr(this, doNotDelete); + _paused = true; + return _this; +} + +void AsyncWebServerRequest::abort() { + if (!_sent) { + _sent = true; + _paused = false; + _this.reset(); + // log_e("AsyncWebServerRequest::abort"); + _client->abort(); } } @@ -634,8 +752,8 @@ size_t AsyncWebServerRequest::headers() const { return _headers.size(); } -bool AsyncWebServerRequest::hasHeader(const char* name) const { - for (const auto& h : _headers) { +bool AsyncWebServerRequest::hasHeader(const char *name) const { + for (const auto &h : _headers) { if (h.name().equalsIgnoreCase(name)) { return true; } @@ -644,24 +762,26 @@ bool AsyncWebServerRequest::hasHeader(const char* name) const { } #ifdef ESP8266 -bool AsyncWebServerRequest::hasHeader(const __FlashStringHelper* data) const { +bool AsyncWebServerRequest::hasHeader(const __FlashStringHelper *data) const { return hasHeader(String(data)); } #endif -const AsyncWebHeader* AsyncWebServerRequest::getHeader(const char* name) const { - auto iter = std::find_if(std::begin(_headers), std::end(_headers), [&name](const AsyncWebHeader& header) { return header.name().equalsIgnoreCase(name); }); +const AsyncWebHeader *AsyncWebServerRequest::getHeader(const char *name) const { + auto iter = std::find_if(std::begin(_headers), std::end(_headers), [&name](const AsyncWebHeader &header) { + return header.name().equalsIgnoreCase(name); + }); return (iter == std::end(_headers)) ? nullptr : &(*iter); } #ifdef ESP8266 -const AsyncWebHeader* AsyncWebServerRequest::getHeader(const __FlashStringHelper* data) const { +const AsyncWebHeader *AsyncWebServerRequest::getHeader(const __FlashStringHelper *data) const { PGM_P p = reinterpret_cast(data); size_t n = strlen_P(p); - char* name = (char*)malloc(n + 1); + char *name = (char *)malloc(n + 1); if (name) { strcpy_P(name, p); - const AsyncWebHeader* result = getHeader(String(name)); + const AsyncWebHeader *result = getHeader(String(name)); free(name); return result; } else { @@ -670,24 +790,26 @@ const AsyncWebHeader* AsyncWebServerRequest::getHeader(const __FlashStringHelper } #endif -const AsyncWebHeader* AsyncWebServerRequest::getHeader(size_t num) const { - if (num >= _headers.size()) +const AsyncWebHeader *AsyncWebServerRequest::getHeader(size_t num) const { + if (num >= _headers.size()) { return nullptr; + } return &(*std::next(_headers.cbegin(), num)); } -size_t AsyncWebServerRequest::getHeaderNames(std::vector& names) const { - const size_t size = _headers.size(); - names.reserve(size); - for (const auto& h : _headers) { +size_t AsyncWebServerRequest::getHeaderNames(std::vector &names) const { + const size_t size = names.size(); + for (const auto &h : _headers) { names.push_back(h.name().c_str()); } - return size; + return names.size() - size; } -bool AsyncWebServerRequest::removeHeader(const char* name) { +bool AsyncWebServerRequest::removeHeader(const char *name) { const size_t size = _headers.size(); - _headers.remove_if([name](const AsyncWebHeader& header) { return header.name().equalsIgnoreCase(name); }); + _headers.remove_if([name](const AsyncWebHeader &header) { + return header.name().equalsIgnoreCase(name); + }); return size != _headers.size(); } @@ -695,8 +817,8 @@ size_t AsyncWebServerRequest::params() const { return _params.size(); } -bool AsyncWebServerRequest::hasParam(const char* name, bool post, bool file) const { - for (const auto& p : _params) { +bool AsyncWebServerRequest::hasParam(const char *name, bool post, bool file) const { + for (const auto &p : _params) { if (p.name().equals(name) && p.isPost() == post && p.isFile() == file) { return true; } @@ -704,8 +826,8 @@ bool AsyncWebServerRequest::hasParam(const char* name, bool post, bool file) con return false; } -const AsyncWebParameter* AsyncWebServerRequest::getParam(const char* name, bool post, bool file) const { - for (const auto& p : _params) { +const AsyncWebParameter *AsyncWebServerRequest::getParam(const char *name, bool post, bool file) const { + for (const auto &p : _params) { if (p.name() == name && p.isPost() == post && p.isFile() == file) { return &p; } @@ -714,122 +836,147 @@ const AsyncWebParameter* AsyncWebServerRequest::getParam(const char* name, bool } #ifdef ESP8266 -const AsyncWebParameter* AsyncWebServerRequest::getParam(const __FlashStringHelper* data, bool post, bool file) const { +const AsyncWebParameter *AsyncWebServerRequest::getParam(const __FlashStringHelper *data, bool post, bool file) const { return getParam(String(data), post, file); } #endif -const AsyncWebParameter* AsyncWebServerRequest::getParam(size_t num) const { - if (num >= _params.size()) +const AsyncWebParameter *AsyncWebServerRequest::getParam(size_t num) const { + if (num >= _params.size()) { return nullptr; + } return &(*std::next(_params.cbegin(), num)); } -const String& AsyncWebServerRequest::getAttribute(const char* name, const String& defaultValue) const { +const String &AsyncWebServerRequest::getAttribute(const char *name, const String &defaultValue) const { auto it = _attributes.find(name); return it != _attributes.end() ? it->second : defaultValue; } -bool AsyncWebServerRequest::getAttribute(const char* name, bool defaultValue) const { +bool AsyncWebServerRequest::getAttribute(const char *name, bool defaultValue) const { auto it = _attributes.find(name); return it != _attributes.end() ? it->second == "1" : defaultValue; } -long AsyncWebServerRequest::getAttribute(const char* name, long defaultValue) const { +long AsyncWebServerRequest::getAttribute(const char *name, long defaultValue) const { auto it = _attributes.find(name); return it != _attributes.end() ? it->second.toInt() : defaultValue; } -float AsyncWebServerRequest::getAttribute(const char* name, float defaultValue) const { +float AsyncWebServerRequest::getAttribute(const char *name, float defaultValue) const { auto it = _attributes.find(name); return it != _attributes.end() ? it->second.toFloat() : defaultValue; } -double AsyncWebServerRequest::getAttribute(const char* name, double defaultValue) const { +double AsyncWebServerRequest::getAttribute(const char *name, double defaultValue) const { auto it = _attributes.find(name); return it != _attributes.end() ? it->second.toDouble() : defaultValue; } -AsyncWebServerResponse* AsyncWebServerRequest::beginResponse(int code, const char* contentType, const char* content, AwsTemplateProcessor callback) { - if (callback) - return new AsyncProgmemResponse(code, contentType, (const uint8_t*)content, strlen(content), callback); +AsyncWebServerResponse *AsyncWebServerRequest::beginResponse(int code, const char *contentType, const char *content, AwsTemplateProcessor callback) { + if (callback) { + return new AsyncProgmemResponse(code, contentType, (const uint8_t *)content, strlen(content), callback); + } return new AsyncBasicResponse(code, contentType, content); } -AsyncWebServerResponse* AsyncWebServerRequest::beginResponse(int code, const char* contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback) { +AsyncWebServerResponse * + AsyncWebServerRequest::beginResponse(int code, const char *contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback) { return new AsyncProgmemResponse(code, contentType, content, len, callback); } -AsyncWebServerResponse* AsyncWebServerRequest::beginResponse(FS& fs, const String& path, const char* contentType, bool download, AwsTemplateProcessor callback) { - if (fs.exists(path) || (!download && fs.exists(path + T__gz))) +AsyncWebServerResponse * + AsyncWebServerRequest::beginResponse(FS &fs, const String &path, const char *contentType, bool download, AwsTemplateProcessor callback) { + if (fs.exists(path) || (!download && fs.exists(path + T__gz))) { return new AsyncFileResponse(fs, path, contentType, download, callback); + } return NULL; } -AsyncWebServerResponse* AsyncWebServerRequest::beginResponse(File content, const String& path, const char* contentType, bool download, AwsTemplateProcessor callback) { - if (content == true) +AsyncWebServerResponse * + AsyncWebServerRequest::beginResponse(File content, const String &path, const char *contentType, bool download, AwsTemplateProcessor callback) { + if (content == true) { return new AsyncFileResponse(content, path, contentType, download, callback); + } return NULL; } -AsyncWebServerResponse* AsyncWebServerRequest::beginResponse(Stream& stream, const char* contentType, size_t len, AwsTemplateProcessor callback) { +AsyncWebServerResponse *AsyncWebServerRequest::beginResponse(Stream &stream, const char *contentType, size_t len, AwsTemplateProcessor callback) { return new AsyncStreamResponse(stream, contentType, len, callback); } -AsyncWebServerResponse* AsyncWebServerRequest::beginResponse(const char* contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback) { +AsyncWebServerResponse * + AsyncWebServerRequest::beginResponse(const char *contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback) { return new AsyncCallbackResponse(contentType, len, callback, templateCallback); } -AsyncWebServerResponse* AsyncWebServerRequest::beginChunkedResponse(const char* contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback) { - if (_version) +AsyncWebServerResponse * + AsyncWebServerRequest::beginChunkedResponse(const char *contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback) { + if (_version) { return new AsyncChunkedResponse(contentType, callback, templateCallback); + } return new AsyncCallbackResponse(contentType, 0, callback, templateCallback); } -AsyncResponseStream* AsyncWebServerRequest::beginResponseStream(const char* contentType, size_t bufferSize) { +AsyncResponseStream *AsyncWebServerRequest::beginResponseStream(const char *contentType, size_t bufferSize) { return new AsyncResponseStream(contentType, bufferSize); } -AsyncWebServerResponse* AsyncWebServerRequest::beginResponse_P(int code, const String& contentType, PGM_P content, AwsTemplateProcessor callback) { - return new AsyncProgmemResponse(code, contentType, (const uint8_t*)content, strlen_P(content), callback); +AsyncWebServerResponse *AsyncWebServerRequest::beginResponse_P(int code, const String &contentType, PGM_P content, AwsTemplateProcessor callback) { + return new AsyncProgmemResponse(code, contentType, (const uint8_t *)content, strlen_P(content), callback); } -void AsyncWebServerRequest::send(AsyncWebServerResponse* response) { - if (_sent) +void AsyncWebServerRequest::send(AsyncWebServerResponse *response) { + // request is already sent on the wire ? + if (_sent) { return; - if (_response) + } + + // if we already had a response, delete it and replace it with the new one + if (_response) { delete _response; + } _response = response; + + // if request was paused, we need to send the response now + if (_paused) { + _paused = false; + _send(); + } } -void AsyncWebServerRequest::redirect(const char* url, int code) { - AsyncWebServerResponse* response = beginResponse(code); +void AsyncWebServerRequest::redirect(const char *url, int code) { + AsyncWebServerResponse *response = beginResponse(code); response->addHeader(T_LOCATION, url); send(response); } -bool AsyncWebServerRequest::authenticate(const char* username, const char* password, const char* realm, bool passwordIsHash) const { +bool AsyncWebServerRequest::authenticate(const char *username, const char *password, const char *realm, bool passwordIsHash) const { if (_authorization.length()) { - if (_authMethod == AsyncAuthType::AUTH_DIGEST) + if (_authMethod == AsyncAuthType::AUTH_DIGEST) { return checkDigestAuthentication(_authorization.c_str(), methodToString(), username, password, realm, passwordIsHash, NULL, NULL, NULL); - else if (!passwordIsHash) + } else if (!passwordIsHash) { return checkBasicAuthentication(_authorization.c_str(), username, password); - else + } else { return _authorization.equals(password); + } } return false; } -bool AsyncWebServerRequest::authenticate(const char* hash) const { - if (!_authorization.length() || hash == NULL) +bool AsyncWebServerRequest::authenticate(const char *hash) const { + if (!_authorization.length() || hash == NULL) { return false; + } if (_authMethod == AsyncAuthType::AUTH_DIGEST) { String hStr = String(hash); int separator = hStr.indexOf(':'); - if (separator <= 0) + if (separator <= 0) { return false; + } String username = hStr.substring(0, separator); hStr = hStr.substring(separator + 1); separator = hStr.indexOf(':'); - if (separator <= 0) + if (separator <= 0) { return false; + } String realm = hStr.substring(0, separator); hStr = hStr.substring(separator + 1); return checkDigestAuthentication(_authorization.c_str(), methodToString(), username.c_str(), hStr.c_str(), realm.c_str(), true, NULL, NULL, NULL); @@ -839,46 +986,65 @@ bool AsyncWebServerRequest::authenticate(const char* hash) const { return (_authorization.equals(hash)); } -void AsyncWebServerRequest::requestAuthentication(AsyncAuthType method, const char* realm, const char* _authFailMsg) { - if (!realm) +void AsyncWebServerRequest::requestAuthentication(AsyncAuthType method, const char *realm, const char *_authFailMsg) { + if (!realm) { realm = T_LOGIN_REQ; + } - AsyncWebServerResponse* r = _authFailMsg ? beginResponse(401, T_text_html, _authFailMsg) : beginResponse(401); + AsyncWebServerResponse *r = _authFailMsg ? beginResponse(401, T_text_html, _authFailMsg) : beginResponse(401); switch (method) { - case AsyncAuthType::AUTH_BASIC: { + case AsyncAuthType::AUTH_BASIC: + { String header; - header.reserve(strlen(T_BASIC_REALM) + strlen(realm) + 1); - header.concat(T_BASIC_REALM); - header.concat(realm); - header.concat('"'); - r->addHeader(T_WWW_AUTH, header.c_str()); + if (header.reserve(strlen(T_BASIC_REALM) + strlen(realm) + 1)) { + header.concat(T_BASIC_REALM); + header.concat(realm); + header.concat('"'); + r->addHeader(T_WWW_AUTH, header.c_str()); + } else { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + abort(); + } + break; } - case AsyncAuthType::AUTH_DIGEST: { + case AsyncAuthType::AUTH_DIGEST: + { size_t len = strlen(T_DIGEST_) + strlen(T_realm__) + strlen(T_auth_nonce) + 32 + strlen(T__opaque) + 32 + 1; String header; - header.reserve(len + strlen(realm)); - header.concat(T_DIGEST_); - header.concat(T_realm__); - header.concat(realm); - header.concat(T_auth_nonce); - header.concat(genRandomMD5()); - header.concat(T__opaque); - header.concat(genRandomMD5()); - header.concat((char)0x22); // '"' - r->addHeader(T_WWW_AUTH, header.c_str()); + if (header.reserve(len + strlen(realm))) { + const String nonce = genRandomMD5(); + const String opaque = genRandomMD5(); + if (nonce.length() && opaque.length()) { + header.concat(T_DIGEST_); + header.concat(T_realm__); + header.concat(realm); + header.concat(T_auth_nonce); + header.concat(nonce); + header.concat(T__opaque); + header.concat(opaque); + header.concat((char)0x22); // '"' + r->addHeader(T_WWW_AUTH, header.c_str()); + } else { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + abort(); + } + } break; } - default: - break; + default: break; } send(r); } -bool AsyncWebServerRequest::hasArg(const char* name) const { - for (const auto& arg : _params) { +bool AsyncWebServerRequest::hasArg(const char *name) const { + for (const auto &arg : _params) { if (arg.name() == name) { return true; } @@ -887,13 +1053,13 @@ bool AsyncWebServerRequest::hasArg(const char* name) const { } #ifdef ESP8266 -bool AsyncWebServerRequest::hasArg(const __FlashStringHelper* data) const { +bool AsyncWebServerRequest::hasArg(const __FlashStringHelper *data) const { return hasArg(String(data).c_str()); } #endif -const String& AsyncWebServerRequest::arg(const char* name) const { - for (const auto& arg : _params) { +const String &AsyncWebServerRequest::arg(const char *name) const { + for (const auto &arg : _params) { if (arg.name() == name) { return arg.value(); } @@ -902,50 +1068,61 @@ const String& AsyncWebServerRequest::arg(const char* name) const { } #ifdef ESP8266 -const String& AsyncWebServerRequest::arg(const __FlashStringHelper* data) const { +const String &AsyncWebServerRequest::arg(const __FlashStringHelper *data) const { return arg(String(data).c_str()); } #endif -const String& AsyncWebServerRequest::arg(size_t i) const { +const String &AsyncWebServerRequest::arg(size_t i) const { return getParam(i)->value(); } -const String& AsyncWebServerRequest::argName(size_t i) const { +const String &AsyncWebServerRequest::argName(size_t i) const { return getParam(i)->name(); } -const String& AsyncWebServerRequest::pathArg(size_t i) const { - return i < _pathParams.size() ? _pathParams[i] : emptyString; +const String &AsyncWebServerRequest::pathArg(size_t i) const { + if (i >= _pathParams.size()) { + return emptyString; + } + auto it = _pathParams.begin(); + std::advance(it, i); + return *it; } -const String& AsyncWebServerRequest::header(const char* name) const { - const AsyncWebHeader* h = getHeader(name); +const String &AsyncWebServerRequest::header(const char *name) const { + const AsyncWebHeader *h = getHeader(name); return h ? h->value() : emptyString; } #ifdef ESP8266 -const String& AsyncWebServerRequest::header(const __FlashStringHelper* data) const { +const String &AsyncWebServerRequest::header(const __FlashStringHelper *data) const { return header(String(data).c_str()); }; #endif -const String& AsyncWebServerRequest::header(size_t i) const { - const AsyncWebHeader* h = getHeader(i); +const String &AsyncWebServerRequest::header(size_t i) const { + const AsyncWebHeader *h = getHeader(i); return h ? h->value() : emptyString; } -const String& AsyncWebServerRequest::headerName(size_t i) const { - const AsyncWebHeader* h = getHeader(i); +const String &AsyncWebServerRequest::headerName(size_t i) const { + const AsyncWebHeader *h = getHeader(i); return h ? h->name() : emptyString; } -String AsyncWebServerRequest::urlDecode(const String& text) const { +String AsyncWebServerRequest::urlDecode(const String &text) const { char temp[] = "0x00"; unsigned int len = text.length(); unsigned int i = 0; String decoded; - decoded.reserve(len); // Allocate the string internal buffer - never longer from source text + // Allocate the string internal buffer - never longer from source text + if (!decoded.reserve(len)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + return emptyString; + } while (i < len) { char decodedChar; char encodedChar = text.charAt(i++); @@ -956,52 +1133,53 @@ String AsyncWebServerRequest::urlDecode(const String& text) const { } else if (encodedChar == '+') { decodedChar = ' '; } else { - decodedChar = encodedChar; // normal ascii char + decodedChar = encodedChar; // normal ascii char } decoded.concat(decodedChar); } return decoded; } -const char* AsyncWebServerRequest::methodToString() const { - if (_method == HTTP_ANY) +const char *AsyncWebServerRequest::methodToString() const { + if (_method == HTTP_ANY) { return T_ANY; - if (_method & HTTP_GET) + } + if (_method & HTTP_GET) { return T_GET; - if (_method & HTTP_POST) + } + if (_method & HTTP_POST) { return T_POST; - if (_method & HTTP_DELETE) + } + if (_method & HTTP_DELETE) { return T_DELETE; - if (_method & HTTP_PUT) + } + if (_method & HTTP_PUT) { return T_PUT; - if (_method & HTTP_PATCH) + } + if (_method & HTTP_PATCH) { return T_PATCH; - if (_method & HTTP_HEAD) + } + if (_method & HTTP_HEAD) { return T_HEAD; - if (_method & HTTP_OPTIONS) + } + if (_method & HTTP_OPTIONS) { return T_OPTIONS; + } return T_UNKNOWN; } -const char* AsyncWebServerRequest::requestedConnTypeToString() const { +const char *AsyncWebServerRequest::requestedConnTypeToString() const { switch (_reqconntype) { - case RCT_NOT_USED: - return T_RCT_NOT_USED; - case RCT_DEFAULT: - return T_RCT_DEFAULT; - case RCT_HTTP: - return T_RCT_HTTP; - case RCT_WS: - return T_RCT_WS; - case RCT_EVENT: - return T_RCT_EVENT; - default: - return T_ERROR; + case RCT_NOT_USED: return T_RCT_NOT_USED; + case RCT_DEFAULT: return T_RCT_DEFAULT; + case RCT_HTTP: return T_RCT_HTTP; + case RCT_WS: return T_RCT_WS; + case RCT_EVENT: return T_RCT_EVENT; + default: return T_ERROR; } } bool AsyncWebServerRequest::isExpectedRequestedConnType(RequestedConnectionType erct1, RequestedConnectionType erct2, RequestedConnectionType erct3) const { - return ((erct1 != RCT_NOT_USED) && (erct1 == _reqconntype)) || - ((erct2 != RCT_NOT_USED) && (erct2 == _reqconntype)) || - ((erct3 != RCT_NOT_USED) && (erct3 == _reqconntype)); + return ((erct1 != RCT_NOT_USED) && (erct1 == _reqconntype)) || ((erct2 != RCT_NOT_USED) && (erct2 == _reqconntype)) + || ((erct3 != RCT_NOT_USED) && (erct3 == _reqconntype)); } diff --git a/src/WebResponseImpl.h b/src/WebResponseImpl.h index fa462b6..80dbca8 100644 --- a/src/WebResponseImpl.h +++ b/src/WebResponseImpl.h @@ -1,30 +1,13 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #ifndef ASYNCWEBSERVERRESPONSEIMPL_H_ #define ASYNCWEBSERVERRESPONSEIMPL_H_ #ifdef Arduino_h - // arduino is not compatible with std::vector - #undef min - #undef max +// arduino is not compatible with std::vector +#undef min +#undef max #endif #include "literals.h" #include @@ -34,127 +17,158 @@ // It is possible to restore these defines, but one can use _min and _max instead. Or std::min, std::max. class AsyncBasicResponse : public AsyncWebServerResponse { - private: - String _content; +private: + String _content; - public: - explicit AsyncBasicResponse(int code, const char* contentType = asyncsrv::empty, const char* content = asyncsrv::empty); - AsyncBasicResponse(int code, const String& contentType, const String& content = emptyString) : AsyncBasicResponse(code, contentType.c_str(), content.c_str()) {} - void _respond(AsyncWebServerRequest* request) override final; - size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time) override final; - bool _sourceValid() const override final { return true; } +public: + explicit AsyncBasicResponse(int code, const char *contentType = asyncsrv::empty, const char *content = asyncsrv::empty); + AsyncBasicResponse(int code, const String &contentType, const String &content = emptyString) + : AsyncBasicResponse(code, contentType.c_str(), content.c_str()) {} + void _respond(AsyncWebServerRequest *request) override final; + size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time) override final; + bool _sourceValid() const override final { + return true; + } }; class AsyncAbstractResponse : public AsyncWebServerResponse { - private: - // amount of responce data in-flight, i.e. sent, but not acked yet - size_t _in_flight{0}; - // in-flight queue credits - size_t _in_flight_credit{2}; - String _head; - // Data is inserted into cache at begin(). - // This is inefficient with vector, but if we use some other container, - // we won't be able to access it as contiguous array of bytes when reading from it, - // so by gaining performance in one place, we'll lose it in another. - std::vector _cache; - size_t _readDataFromCacheOrContent(uint8_t* data, const size_t len); - size_t _fillBufferAndProcessTemplates(uint8_t* buf, size_t maxLen); +private: +#if ASYNCWEBSERVER_USE_CHUNK_INFLIGHT + // amount of response data in-flight, i.e. sent, but not acked yet + size_t _in_flight{0}; + // in-flight queue credits + size_t _in_flight_credit{2}; +#endif + String _head; + // Data is inserted into cache at begin(). + // This is inefficient with vector, but if we use some other container, + // we won't be able to access it as contiguous array of bytes when reading from it, + // so by gaining performance in one place, we'll lose it in another. + std::vector _cache; + size_t _readDataFromCacheOrContent(uint8_t *data, const size_t len); + size_t _fillBufferAndProcessTemplates(uint8_t *buf, size_t maxLen); - protected: - AwsTemplateProcessor _callback; +protected: + AwsTemplateProcessor _callback; - public: - AsyncAbstractResponse(AwsTemplateProcessor callback = nullptr); - virtual ~AsyncAbstractResponse() {} - void _respond(AsyncWebServerRequest* request) override final; - size_t _ack(AsyncWebServerRequest* request, size_t len, uint32_t time) override final; - virtual bool _sourceValid() const { return false; } - virtual size_t _fillBuffer(uint8_t* buf __attribute__((unused)), size_t maxLen __attribute__((unused))) { return 0; } +public: + AsyncAbstractResponse(AwsTemplateProcessor callback = nullptr); + virtual ~AsyncAbstractResponse() {} + void _respond(AsyncWebServerRequest *request) override final; + size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time) override final; + virtual bool _sourceValid() const { + return false; + } + virtual size_t _fillBuffer(uint8_t *buf __attribute__((unused)), size_t maxLen __attribute__((unused))) { + return 0; + } }; #ifndef TEMPLATE_PLACEHOLDER - #define TEMPLATE_PLACEHOLDER '%' +#define TEMPLATE_PLACEHOLDER '%' #endif #define TEMPLATE_PARAM_NAME_LENGTH 32 class AsyncFileResponse : public AsyncAbstractResponse { - using File = fs::File; - using FS = fs::FS; + using File = fs::File; + using FS = fs::FS; - private: - File _content; - String _path; - void _setContentTypeFromPath(const String& path); +private: + File _content; + String _path; + void _setContentTypeFromPath(const String &path); - public: - AsyncFileResponse(FS& fs, const String& path, const char* contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr); - AsyncFileResponse(FS& fs, const String& path, const String& contentType, bool download = false, AwsTemplateProcessor callback = nullptr) : AsyncFileResponse(fs, path, contentType.c_str(), download, callback) {} - AsyncFileResponse(File content, const String& path, const char* contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr); - AsyncFileResponse(File content, const String& path, const String& contentType, bool download = false, AwsTemplateProcessor callack = nullptr) : AsyncFileResponse(content, path, contentType.c_str(), download, callack) {} - ~AsyncFileResponse() { _content.close(); } - bool _sourceValid() const override final { return !!(_content); } - size_t _fillBuffer(uint8_t* buf, size_t maxLen) override final; +public: + AsyncFileResponse(FS &fs, const String &path, const char *contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr); + AsyncFileResponse(FS &fs, const String &path, const String &contentType, bool download = false, AwsTemplateProcessor callback = nullptr) + : AsyncFileResponse(fs, path, contentType.c_str(), download, callback) {} + AsyncFileResponse( + File content, const String &path, const char *contentType = asyncsrv::empty, bool download = false, AwsTemplateProcessor callback = nullptr + ); + AsyncFileResponse(File content, const String &path, const String &contentType, bool download = false, AwsTemplateProcessor callback = nullptr) + : AsyncFileResponse(content, path, contentType.c_str(), download, callback) {} + ~AsyncFileResponse() { + _content.close(); + } + bool _sourceValid() const override final { + return !!(_content); + } + size_t _fillBuffer(uint8_t *buf, size_t maxLen) override final; }; class AsyncStreamResponse : public AsyncAbstractResponse { - private: - Stream* _content; +private: + Stream *_content; - public: - AsyncStreamResponse(Stream& stream, const char* contentType, size_t len, AwsTemplateProcessor callback = nullptr); - AsyncStreamResponse(Stream& stream, const String& contentType, size_t len, AwsTemplateProcessor callback = nullptr) : AsyncStreamResponse(stream, contentType.c_str(), len, callback) {} - bool _sourceValid() const override final { return !!(_content); } - size_t _fillBuffer(uint8_t* buf, size_t maxLen) override final; +public: + AsyncStreamResponse(Stream &stream, const char *contentType, size_t len, AwsTemplateProcessor callback = nullptr); + AsyncStreamResponse(Stream &stream, const String &contentType, size_t len, AwsTemplateProcessor callback = nullptr) + : AsyncStreamResponse(stream, contentType.c_str(), len, callback) {} + bool _sourceValid() const override final { + return !!(_content); + } + size_t _fillBuffer(uint8_t *buf, size_t maxLen) override final; }; class AsyncCallbackResponse : public AsyncAbstractResponse { - private: - AwsResponseFiller _content; - size_t _filledLength; +private: + AwsResponseFiller _content; + size_t _filledLength; - public: - AsyncCallbackResponse(const char* contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); - AsyncCallbackResponse(const String& contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) : AsyncCallbackResponse(contentType.c_str(), len, callback, templateCallback) {} - bool _sourceValid() const override final { return !!(_content); } - size_t _fillBuffer(uint8_t* buf, size_t maxLen) override final; +public: + AsyncCallbackResponse(const char *contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); + AsyncCallbackResponse(const String &contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) + : AsyncCallbackResponse(contentType.c_str(), len, callback, templateCallback) {} + bool _sourceValid() const override final { + return !!(_content); + } + size_t _fillBuffer(uint8_t *buf, size_t maxLen) override final; }; class AsyncChunkedResponse : public AsyncAbstractResponse { - private: - AwsResponseFiller _content; - size_t _filledLength; +private: + AwsResponseFiller _content; + size_t _filledLength; - public: - AsyncChunkedResponse(const char* contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); - AsyncChunkedResponse(const String& contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) : AsyncChunkedResponse(contentType.c_str(), callback, templateCallback) {} - bool _sourceValid() const override final { return !!(_content); } - size_t _fillBuffer(uint8_t* buf, size_t maxLen) override final; +public: + AsyncChunkedResponse(const char *contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr); + AsyncChunkedResponse(const String &contentType, AwsResponseFiller callback, AwsTemplateProcessor templateCallback = nullptr) + : AsyncChunkedResponse(contentType.c_str(), callback, templateCallback) {} + bool _sourceValid() const override final { + return !!(_content); + } + size_t _fillBuffer(uint8_t *buf, size_t maxLen) override final; }; class AsyncProgmemResponse : public AsyncAbstractResponse { - private: - const uint8_t* _content; - size_t _readLength; +private: + const uint8_t *_content; + size_t _readLength; - public: - AsyncProgmemResponse(int code, const char* contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr); - AsyncProgmemResponse(int code, const String& contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback = nullptr) : AsyncProgmemResponse(code, contentType.c_str(), content, len, callback) {} - bool _sourceValid() const override final { return true; } - size_t _fillBuffer(uint8_t* buf, size_t maxLen) override final; +public: + AsyncProgmemResponse(int code, const char *contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr); + AsyncProgmemResponse(int code, const String &contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback = nullptr) + : AsyncProgmemResponse(code, contentType.c_str(), content, len, callback) {} + bool _sourceValid() const override final { + return true; + } + size_t _fillBuffer(uint8_t *buf, size_t maxLen) override final; }; class AsyncResponseStream : public AsyncAbstractResponse, public Print { - private: - StreamString _content; +private: + StreamString _content; - public: - AsyncResponseStream(const char* contentType, size_t bufferSize); - AsyncResponseStream(const String& contentType, size_t bufferSize) : AsyncResponseStream(contentType.c_str(), bufferSize) {} - bool _sourceValid() const override final { return (_state < RESPONSE_END); } - size_t _fillBuffer(uint8_t* buf, size_t maxLen) override final; - size_t write(const uint8_t* data, size_t len); - size_t write(uint8_t data); - using Print::write; +public: + AsyncResponseStream(const char *contentType, size_t bufferSize); + AsyncResponseStream(const String &contentType, size_t bufferSize) : AsyncResponseStream(contentType.c_str(), bufferSize) {} + bool _sourceValid() const override final { + return (_state < RESPONSE_END); + } + size_t _fillBuffer(uint8_t *buf, size_t maxLen) override final; + size_t write(const uint8_t *data, size_t len); + size_t write(uint8_t data); + using Print::write; }; #endif /* ASYNCWEBSERVERRESPONSEIMPL_H_ */ diff --git a/src/WebResponses.cpp b/src/WebResponses.cpp index bf8235e..f5d4653 100644 --- a/src/WebResponses.cpp +++ b/src/WebResponses.cpp @@ -1,34 +1,19 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #include "ESPAsyncWebServer.h" #include "WebResponseImpl.h" using namespace asyncsrv; // Since ESP8266 does not link memchr by default, here's its implementation. -void* memchr(void* ptr, int ch, size_t count) { - unsigned char* p = static_cast(ptr); - while (count--) - if (*p++ == static_cast(ch)) +void *memchr(void *ptr, int ch, size_t count) { + unsigned char *p = static_cast(ptr); + while (count--) { + if (*p++ == static_cast(ch)) { return --p; + } + } return nullptr; } @@ -37,120 +22,95 @@ void* memchr(void* ptr, int ch, size_t count) { * */ -const char* AsyncWebServerResponse::responseCodeToString(int code) { +const char *AsyncWebServerResponse::responseCodeToString(int code) { switch (code) { - case 100: - return T_HTTP_CODE_100; - case 101: - return T_HTTP_CODE_101; - case 200: - return T_HTTP_CODE_200; - case 201: - return T_HTTP_CODE_201; - case 202: - return T_HTTP_CODE_202; - case 203: - return T_HTTP_CODE_203; - case 204: - return T_HTTP_CODE_204; - case 205: - return T_HTTP_CODE_205; - case 206: - return T_HTTP_CODE_206; - case 300: - return T_HTTP_CODE_300; - case 301: - return T_HTTP_CODE_301; - case 302: - return T_HTTP_CODE_302; - case 303: - return T_HTTP_CODE_303; - case 304: - return T_HTTP_CODE_304; - case 305: - return T_HTTP_CODE_305; - case 307: - return T_HTTP_CODE_307; - case 400: - return T_HTTP_CODE_400; - case 401: - return T_HTTP_CODE_401; - case 402: - return T_HTTP_CODE_402; - case 403: - return T_HTTP_CODE_403; - case 404: - return T_HTTP_CODE_404; - case 405: - return T_HTTP_CODE_405; - case 406: - return T_HTTP_CODE_406; - case 407: - return T_HTTP_CODE_407; - case 408: - return T_HTTP_CODE_408; - case 409: - return T_HTTP_CODE_409; - case 410: - return T_HTTP_CODE_410; - case 411: - return T_HTTP_CODE_411; - case 412: - return T_HTTP_CODE_412; - case 413: - return T_HTTP_CODE_413; - case 414: - return T_HTTP_CODE_414; - case 415: - return T_HTTP_CODE_415; - case 416: - return T_HTTP_CODE_416; - case 417: - return T_HTTP_CODE_417; - case 429: - return T_HTTP_CODE_429; - case 500: - return T_HTTP_CODE_500; - case 501: - return T_HTTP_CODE_501; - case 502: - return T_HTTP_CODE_502; - case 503: - return T_HTTP_CODE_503; - case 504: - return T_HTTP_CODE_504; - case 505: - return T_HTTP_CODE_505; - default: - return T_HTTP_CODE_ANY; + case 100: return T_HTTP_CODE_100; + case 101: return T_HTTP_CODE_101; + case 200: return T_HTTP_CODE_200; + case 201: return T_HTTP_CODE_201; + case 202: return T_HTTP_CODE_202; + case 203: return T_HTTP_CODE_203; + case 204: return T_HTTP_CODE_204; + case 205: return T_HTTP_CODE_205; + case 206: return T_HTTP_CODE_206; + case 300: return T_HTTP_CODE_300; + case 301: return T_HTTP_CODE_301; + case 302: return T_HTTP_CODE_302; + case 303: return T_HTTP_CODE_303; + case 304: return T_HTTP_CODE_304; + case 305: return T_HTTP_CODE_305; + case 307: return T_HTTP_CODE_307; + case 400: return T_HTTP_CODE_400; + case 401: return T_HTTP_CODE_401; + case 402: return T_HTTP_CODE_402; + case 403: return T_HTTP_CODE_403; + case 404: return T_HTTP_CODE_404; + case 405: return T_HTTP_CODE_405; + case 406: return T_HTTP_CODE_406; + case 407: return T_HTTP_CODE_407; + case 408: return T_HTTP_CODE_408; + case 409: return T_HTTP_CODE_409; + case 410: return T_HTTP_CODE_410; + case 411: return T_HTTP_CODE_411; + case 412: return T_HTTP_CODE_412; + case 413: return T_HTTP_CODE_413; + case 414: return T_HTTP_CODE_414; + case 415: return T_HTTP_CODE_415; + case 416: return T_HTTP_CODE_416; + case 417: return T_HTTP_CODE_417; + case 429: return T_HTTP_CODE_429; + case 500: return T_HTTP_CODE_500; + case 501: return T_HTTP_CODE_501; + case 502: return T_HTTP_CODE_502; + case 503: return T_HTTP_CODE_503; + case 504: return T_HTTP_CODE_504; + case 505: return T_HTTP_CODE_505; + default: return T_HTTP_CODE_ANY; } } AsyncWebServerResponse::AsyncWebServerResponse() - : _code(0), _contentType(), _contentLength(0), _sendContentLength(true), _chunked(false), _headLength(0), _sentLength(0), _ackedLength(0), _writtenLength(0), _state(RESPONSE_SETUP) { - for (const auto& header : DefaultHeaders::Instance()) { + : _code(0), _contentType(), _contentLength(0), _sendContentLength(true), _chunked(false), _headLength(0), _sentLength(0), _ackedLength(0), _writtenLength(0), + _state(RESPONSE_SETUP) { + for (const auto &header : DefaultHeaders::Instance()) { _headers.emplace_back(header); } } void AsyncWebServerResponse::setCode(int code) { - if (_state == RESPONSE_SETUP) + if (_state == RESPONSE_SETUP) { _code = code; + } } void AsyncWebServerResponse::setContentLength(size_t len) { - if (_state == RESPONSE_SETUP && addHeader(T_Content_Length, len, true)) + if (_state == RESPONSE_SETUP && addHeader(T_Content_Length, len, true)) { _contentLength = len; + } } -void AsyncWebServerResponse::setContentType(const char* type) { - if (_state == RESPONSE_SETUP && addHeader(T_Content_Type, type, true)) +void AsyncWebServerResponse::setContentType(const char *type) { + if (_state == RESPONSE_SETUP && addHeader(T_Content_Type, type, true)) { _contentType = type; + } } -bool AsyncWebServerResponse::removeHeader(const char* name) { - for (auto i = _headers.begin(); i != _headers.end(); ++i) { +bool AsyncWebServerResponse::removeHeader(const char *name) { + bool h_erased = false; + for (auto i = _headers.begin(); i != _headers.end();) { if (i->name().equalsIgnoreCase(name)) { + _headers.erase(i); + h_erased = true; + } else { + ++i; + } + } + return h_erased; +} + +bool AsyncWebServerResponse::removeHeader(const char *name, const char *value) { + for (auto i = _headers.begin(); i != _headers.end(); ++i) { + if (i->name().equalsIgnoreCase(name) && i->value().equalsIgnoreCase(value)) { _headers.erase(i); return true; } @@ -158,12 +118,23 @@ bool AsyncWebServerResponse::removeHeader(const char* name) { return false; } -const AsyncWebHeader* AsyncWebServerResponse::getHeader(const char* name) const { - auto iter = std::find_if(std::begin(_headers), std::end(_headers), [&name](const AsyncWebHeader& header) { return header.name().equalsIgnoreCase(name); }); +const AsyncWebHeader *AsyncWebServerResponse::getHeader(const char *name) const { + auto iter = std::find_if(std::begin(_headers), std::end(_headers), [&name](const AsyncWebHeader &header) { + return header.name().equalsIgnoreCase(name); + }); return (iter == std::end(_headers)) ? nullptr : &(*iter); } -bool AsyncWebServerResponse::addHeader(const char* name, const char* value, bool replaceExisting) { +bool AsyncWebServerResponse::headerMustBePresentOnce(const String &name) { + for (uint8_t i = 0; i < T_only_once_headers_len; i++) { + if (name.equalsIgnoreCase(T_only_once_headers[i])) { + return true; + } + } + return false; +} + +bool AsyncWebServerResponse::addHeader(const char *name, const char *value, bool replaceExisting) { for (auto i = _headers.begin(); i != _headers.end(); ++i) { if (i->name().equalsIgnoreCase(name)) { // header already set @@ -171,9 +142,11 @@ bool AsyncWebServerResponse::addHeader(const char* name, const char* value, bool // remove, break and add the new one _headers.erase(i); break; - } else { + } else if (headerMustBePresentOnce(i->name())) { // we can have only one header with that name // do not update return false; + } else { + break; // accept multiple headers with the same name } } } @@ -182,24 +155,28 @@ bool AsyncWebServerResponse::addHeader(const char* name, const char* value, bool return true; } -void AsyncWebServerResponse::_assembleHead(String& buffer, uint8_t version) { +void AsyncWebServerResponse::_assembleHead(String &buffer, uint8_t version) { if (version) { addHeader(T_Accept_Ranges, T_none, false); - if (_chunked) + if (_chunked) { addHeader(T_Transfer_Encoding, T_chunked, false); + } } - if (_sendContentLength) + if (_sendContentLength) { addHeader(T_Content_Length, String(_contentLength), false); + } - if (_contentType.length()) + if (_contentType.length()) { addHeader(T_Content_Type, _contentType.c_str(), false); + } // precompute buffer size to avoid reallocations by String class size_t len = 0; - len += 50; // HTTP/1.1 200 \r\n - for (const auto& header : _headers) + len += 50; // HTTP/1.1 200 \r\n + for (const auto &header : _headers) { len += header.name().length() + header.value().length() + 4; + } // prepare buffer buffer.reserve(len); @@ -218,7 +195,7 @@ void AsyncWebServerResponse::_assembleHead(String& buffer, uint8_t version) { buffer.concat(T_rn); // Add headers - for (const auto& header : _headers) { + for (const auto &header : _headers) { buffer.concat(header.name()); #ifdef ESP8266 buffer.concat(PSTR(": ")); @@ -233,15 +210,23 @@ void AsyncWebServerResponse::_assembleHead(String& buffer, uint8_t version) { _headLength = buffer.length(); } -bool AsyncWebServerResponse::_started() const { return _state > RESPONSE_SETUP; } -bool AsyncWebServerResponse::_finished() const { return _state > RESPONSE_WAIT_ACK; } -bool AsyncWebServerResponse::_failed() const { return _state == RESPONSE_FAILED; } -bool AsyncWebServerResponse::_sourceValid() const { return false; } -void AsyncWebServerResponse::_respond(AsyncWebServerRequest* request) { +bool AsyncWebServerResponse::_started() const { + return _state > RESPONSE_SETUP; +} +bool AsyncWebServerResponse::_finished() const { + return _state > RESPONSE_WAIT_ACK; +} +bool AsyncWebServerResponse::_failed() const { + return _state == RESPONSE_FAILED; +} +bool AsyncWebServerResponse::_sourceValid() const { + return false; +} +void AsyncWebServerResponse::_respond(AsyncWebServerRequest *request) { _state = RESPONSE_END; request->client()->close(); } -size_t AsyncWebServerResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time) { +size_t AsyncWebServerResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time) { (void)request; (void)len; (void)time; @@ -251,19 +236,20 @@ size_t AsyncWebServerResponse::_ack(AsyncWebServerRequest* request, size_t len, /* * String/Code Response * */ -AsyncBasicResponse::AsyncBasicResponse(int code, const char* contentType, const char* content) { +AsyncBasicResponse::AsyncBasicResponse(int code, const char *contentType, const char *content) { _code = code; _content = content; _contentType = contentType; if (_content.length()) { _contentLength = _content.length(); - if (!_contentType.length()) + if (!_contentType.length()) { _contentType = T_text_plain; + } } addHeader(T_Connection, T_close, false); } -void AsyncBasicResponse::_respond(AsyncWebServerRequest* request) { +void AsyncBasicResponse::_respond(AsyncWebServerRequest *request) { _state = RESPONSE_HEADERS; String out; _assembleHead(out, request->version()); @@ -298,7 +284,7 @@ void AsyncBasicResponse::_respond(AsyncWebServerRequest* request) { } } -size_t AsyncBasicResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time) { +size_t AsyncBasicResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time) { (void)time; _ackedLength += len; if (_state == RESPONSE_CONTENT) { @@ -338,23 +324,26 @@ AsyncAbstractResponse::AsyncAbstractResponse(AwsTemplateProcessor callback) : _c } } -void AsyncAbstractResponse::_respond(AsyncWebServerRequest* request) { +void AsyncAbstractResponse::_respond(AsyncWebServerRequest *request) { addHeader(T_Connection, T_close, false); _assembleHead(_head, request->version()); _state = RESPONSE_HEADERS; _ack(request, 0, 0); } -size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, uint32_t time) { +size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest *request, size_t len, uint32_t time) { (void)time; if (!_sourceValid()) { _state = RESPONSE_FAILED; request->client()->close(); return 0; } + +#if ASYNCWEBSERVER_USE_CHUNK_INFLIGHT // return a credit for each chunk of acked data (polls does not give any credits) - if (len) + if (len) { ++_in_flight_credit; + } // for chunked responses ignore acks if there are no _in_flight_credits left if (_chunked && !_in_flight_credit) { @@ -364,9 +353,11 @@ size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, u return 0; } - _ackedLength += len; _in_flight -= (_in_flight > len) ? len : _in_flight; // get the size of available sock space +#endif + + _ackedLength += len; size_t space = request->client()->space(); size_t headLen = _head.length(); @@ -378,13 +369,16 @@ size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, u String out = _head.substring(0, space); _head = _head.substring(space); _writtenLength += request->client()->write(out.c_str(), out.length()); +#if ASYNCWEBSERVER_USE_CHUNK_INFLIGHT _in_flight += out.length(); - --_in_flight_credit; // take a credit + --_in_flight_credit; // take a credit +#endif return out.length(); } } if (_state == RESPONSE_CONTENT) { +#if ASYNCWEBSERVER_USE_CHUNK_INFLIGHT // for response data we need to control the queue and in-flight fragmentation. Sending small chunks could give low latency, // but flood asynctcp's queue and fragment socket buffer space for large responses. // Let's ignore polled acks and acks in case when we have more in-flight data then the available socket buff space. @@ -392,10 +386,12 @@ size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, u if (_in_flight > space) { // log_d("defer user call %u/%u", _in_flight, space); // take the credit back since we are ignoring this ack and rely on other inflight data - if (len) + if (len) { --_in_flight_credit; + } return 0; } +#endif size_t outLen; if (_chunked) { @@ -410,9 +406,12 @@ size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, u outLen = ((_contentLength - _sentLength) > space) ? space : (_contentLength - _sentLength); } - uint8_t* buf = (uint8_t*)malloc(outLen + headLen); + uint8_t *buf = (uint8_t *)malloc(outLen + headLen); if (!buf) { - // os_printf("_ack malloc %d failed\n", outLen+headLen); +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + request->abort(); return 0; } @@ -430,7 +429,7 @@ size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, u free(buf); return 0; } - outLen = sprintf((char*)buf + headLen, "%04x", readLen) + headLen; + outLen = sprintf((char *)buf + headLen, "%04x", readLen) + headLen; buf[outLen++] = '\r'; buf[outLen++] = '\n'; outLen += readLen; @@ -450,9 +449,11 @@ size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, u } if (outLen) { - _writtenLength += request->client()->write((const char*)buf, outLen); + _writtenLength += request->client()->write((const char *)buf, outLen); +#if ASYNCWEBSERVER_USE_CHUNK_INFLIGHT _in_flight += outLen; - --_in_flight_credit; // take a credit + --_in_flight_credit; // take a credit +#endif } if (_chunked) { @@ -471,14 +472,15 @@ size_t AsyncAbstractResponse::_ack(AsyncWebServerRequest* request, size_t len, u } else if (_state == RESPONSE_WAIT_ACK) { if (!_sendContentLength || _ackedLength >= _writtenLength) { _state = RESPONSE_END; - if (!_chunked && !_sendContentLength) + if (!_chunked && !_sendContentLength) { request->client()->close(true); + } } } return 0; } -size_t AsyncAbstractResponse::_readDataFromCacheOrContent(uint8_t* data, const size_t len) { +size_t AsyncAbstractResponse::_readDataFromCacheOrContent(uint8_t *data, const size_t len) { // If we have something in cache, copy it to buffer const size_t readFromCache = std::min(len, _cache.size()); if (readFromCache) { @@ -491,17 +493,20 @@ size_t AsyncAbstractResponse::_readDataFromCacheOrContent(uint8_t* data, const s return readFromCache + readFromContent; } -size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t* data, size_t len) { - if (!_callback) +size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t *data, size_t len) { + if (!_callback) { return _fillBuffer(data, len); + } const size_t originalLen = len; len = _readDataFromCacheOrContent(data, len); // Now we've read 'len' bytes, either from cache or from file // Search for template placeholders - uint8_t* pTemplateStart = data; - while ((pTemplateStart < &data[len]) && (pTemplateStart = (uint8_t*)memchr(pTemplateStart, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart + 1))) { // data[0] ... data[len - 1] - uint8_t* pTemplateEnd = (pTemplateStart < &data[len - 1]) ? (uint8_t*)memchr(pTemplateStart + 1, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart) : nullptr; + uint8_t *pTemplateStart = data; + while ((pTemplateStart < &data[len]) && (pTemplateStart = (uint8_t *)memchr(pTemplateStart, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart + 1)) + ) { // data[0] ... data[len - 1] + uint8_t *pTemplateEnd = + (pTemplateStart < &data[len - 1]) ? (uint8_t *)memchr(pTemplateStart + 1, TEMPLATE_PLACEHOLDER, &data[len - 1] - pTemplateStart) : nullptr; // temporary buffer to hold parameter name uint8_t buf[TEMPLATE_PARAM_NAME_LENGTH + 1]; String paramName; @@ -512,35 +517,39 @@ size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t* data, size if (paramNameLength) { memcpy(buf, pTemplateStart + 1, paramNameLength); buf[paramNameLength] = 0; - paramName = String(reinterpret_cast(buf)); - } else { // double percent sign encountered, this is single percent sign escaped. + paramName = String(reinterpret_cast(buf)); + } else { // double percent sign encountered, this is single percent sign escaped. // remove the 2nd percent sign memmove(pTemplateEnd, pTemplateEnd + 1, &data[len] - pTemplateEnd - 1); len += _readDataFromCacheOrContent(&data[len - 1], 1) - 1; ++pTemplateStart; } - } else if (&data[len - 1] - pTemplateStart + 1 < TEMPLATE_PARAM_NAME_LENGTH + 2) { // closing placeholder not found, check if it's in the remaining file data + } else if (&data[len - 1] - pTemplateStart + 1 + < TEMPLATE_PARAM_NAME_LENGTH + 2) { // closing placeholder not found, check if it's in the remaining file data memcpy(buf, pTemplateStart + 1, &data[len - 1] - pTemplateStart); - const size_t readFromCacheOrContent = _readDataFromCacheOrContent(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PARAM_NAME_LENGTH + 2 - (&data[len - 1] - pTemplateStart + 1)); + const size_t readFromCacheOrContent = + _readDataFromCacheOrContent(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PARAM_NAME_LENGTH + 2 - (&data[len - 1] - pTemplateStart + 1)); if (readFromCacheOrContent) { - pTemplateEnd = (uint8_t*)memchr(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PLACEHOLDER, readFromCacheOrContent); + pTemplateEnd = (uint8_t *)memchr(buf + (&data[len - 1] - pTemplateStart), TEMPLATE_PLACEHOLDER, readFromCacheOrContent); if (pTemplateEnd) { // prepare argument to callback *pTemplateEnd = 0; - paramName = String(reinterpret_cast(buf)); + paramName = String(reinterpret_cast(buf)); // Copy remaining read-ahead data into cache _cache.insert(_cache.begin(), pTemplateEnd + 1, buf + (&data[len - 1] - pTemplateStart) + readFromCacheOrContent); pTemplateEnd = &data[len - 1]; - } else // closing placeholder not found in file data, store found percent symbol as is and advance to the next position + } else // closing placeholder not found in file data, store found percent symbol as is and advance to the next position { // but first, store read file data in cache _cache.insert(_cache.begin(), buf + (&data[len - 1] - pTemplateStart), buf + (&data[len - 1] - pTemplateStart) + readFromCacheOrContent); ++pTemplateStart; } - } else // closing placeholder not found in content data, store found percent symbol as is and advance to the next position + } else { // closing placeholder not found in content data, store found percent symbol as is and advance to the next position ++pTemplateStart; - } else // closing placeholder not found in content data, store found percent symbol as is and advance to the next position + } + } else { // closing placeholder not found in content data, store found percent symbol as is and advance to the next position ++pTemplateStart; + } if (paramName.length()) { // call callback and replace with result. // Everything in range [pTemplateStart, pTemplateEnd] can be safely replaced with parameter value. @@ -548,7 +557,7 @@ size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t* data, size // The first byte of data after placeholder is located at pTemplateEnd + 1. // It should be located at pTemplateStart + numBytesCopied (to begin right after inserted parameter value). const String paramValue(_callback(paramName)); - const char* pvstr = paramValue.c_str(); + const char *pvstr = paramValue.c_str(); const unsigned int pvlen = paramValue.length(); const size_t numBytesCopied = std::min(pvlen, static_cast(&data[originalLen - 1] - pTemplateStart + 1)); // make room for param value @@ -557,27 +566,28 @@ size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t* data, size _cache.insert(_cache.begin(), &data[originalLen - (pTemplateStart + numBytesCopied - pTemplateEnd - 1)], &data[len]); // 2. parameter value is longer than placeholder text, push the data after placeholder which not saved into cache further to the end memmove(pTemplateStart + numBytesCopied, pTemplateEnd + 1, &data[originalLen] - pTemplateStart - numBytesCopied); - len = originalLen; // fix issue with truncated data, not sure if it has any side effects - } else if (pTemplateEnd + 1 != pTemplateStart + numBytesCopied) + len = originalLen; // fix issue with truncated data, not sure if it has any side effects + } else if (pTemplateEnd + 1 != pTemplateStart + numBytesCopied) { // 2. Either parameter value is shorter than placeholder text OR there is enough free space in buffer to fit. // Move the entire data after the placeholder memmove(pTemplateStart + numBytesCopied, pTemplateEnd + 1, &data[len] - pTemplateEnd - 1); + } // 3. replace placeholder with actual value memcpy(pTemplateStart, pvstr, numBytesCopied); // If result is longer than buffer, copy the remainder into cache (this could happen only if placeholder text itself did not fit entirely in buffer) if (numBytesCopied < pvlen) { _cache.insert(_cache.begin(), pvstr + numBytesCopied, pvstr + pvlen); - } else if (pTemplateStart + numBytesCopied < pTemplateEnd + 1) { // result is copied fully; if result is shorter than placeholder text... + } else if (pTemplateStart + numBytesCopied < pTemplateEnd + 1) { // result is copied fully; if result is shorter than placeholder text... // there is some free room, fill it from cache const size_t roomFreed = pTemplateEnd + 1 - pTemplateStart - numBytesCopied; const size_t totalFreeRoom = originalLen - len + roomFreed; len += _readDataFromCacheOrContent(&data[len - roomFreed], totalFreeRoom) - roomFreed; - } else { // result is copied fully; it is longer than placeholder text + } else { // result is copied fully; it is longer than placeholder text const size_t roomTaken = pTemplateStart + numBytesCopied - pTemplateEnd - 1; len = std::min(len + roomTaken, originalLen); } } - } // while(pTemplateStart) + } // while(pTemplateStart) return len; } @@ -585,64 +595,66 @@ size_t AsyncAbstractResponse::_fillBufferAndProcessTemplates(uint8_t* data, size * File Response * */ -void AsyncFileResponse::_setContentTypeFromPath(const String& path) { +void AsyncFileResponse::_setContentTypeFromPath(const String &path) { #if HAVE_EXTERN_GET_Content_Type_FUNCTION - #ifndef ESP8266 - extern const char* getContentType(const String& path); - #else - extern const __FlashStringHelper* getContentType(const String& path); - #endif +#ifndef ESP8266 + extern const char *getContentType(const String &path); +#else + extern const __FlashStringHelper *getContentType(const String &path); +#endif _contentType = getContentType(path); #else - if (path.endsWith(T__html)) + if (path.endsWith(T__html)) { _contentType = T_text_html; - else if (path.endsWith(T__htm)) + } else if (path.endsWith(T__htm)) { _contentType = T_text_html; - else if (path.endsWith(T__css)) + } else if (path.endsWith(T__css)) { _contentType = T_text_css; - else if (path.endsWith(T__json)) + } else if (path.endsWith(T__json)) { _contentType = T_application_json; - else if (path.endsWith(T__js)) + } else if (path.endsWith(T__js)) { _contentType = T_application_javascript; - else if (path.endsWith(T__png)) + } else if (path.endsWith(T__png)) { _contentType = T_image_png; - else if (path.endsWith(T__gif)) + } else if (path.endsWith(T__gif)) { _contentType = T_image_gif; - else if (path.endsWith(T__jpg)) + } else if (path.endsWith(T__jpg)) { _contentType = T_image_jpeg; - else if (path.endsWith(T__ico)) + } else if (path.endsWith(T__ico)) { _contentType = T_image_x_icon; - else if (path.endsWith(T__svg)) + } else if (path.endsWith(T__svg)) { _contentType = T_image_svg_xml; - else if (path.endsWith(T__eot)) + } else if (path.endsWith(T__eot)) { _contentType = T_font_eot; - else if (path.endsWith(T__woff)) + } else if (path.endsWith(T__woff)) { _contentType = T_font_woff; - else if (path.endsWith(T__woff2)) + } else if (path.endsWith(T__woff2)) { _contentType = T_font_woff2; - else if (path.endsWith(T__ttf)) + } else if (path.endsWith(T__ttf)) { _contentType = T_font_ttf; - else if (path.endsWith(T__xml)) + } else if (path.endsWith(T__xml)) { _contentType = T_text_xml; - else if (path.endsWith(T__pdf)) + } else if (path.endsWith(T__pdf)) { _contentType = T_application_pdf; - else if (path.endsWith(T__zip)) + } else if (path.endsWith(T__zip)) { _contentType = T_application_zip; - else if (path.endsWith(T__gz)) + } else if (path.endsWith(T__gz)) { _contentType = T_application_x_gzip; - else + } else { _contentType = T_text_plain; + } #endif } -AsyncFileResponse::AsyncFileResponse(FS& fs, const String& path, const char* contentType, bool download, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) { +AsyncFileResponse::AsyncFileResponse(FS &fs, const String &path, const char *contentType, bool download, AwsTemplateProcessor callback) + : AsyncAbstractResponse(callback) { _code = 200; _path = path; if (!download && !fs.exists(_path) && fs.exists(_path + T__gz)) { _path = _path + T__gz; addHeader(T_Content_Encoding, T_gzip, false); - _callback = nullptr; // Unable to process zipped templates + _callback = nullptr; // Unable to process zipped templates _sendContentLength = true; _chunked = false; } @@ -650,14 +662,15 @@ AsyncFileResponse::AsyncFileResponse(FS& fs, const String& path, const char* con _content = fs.open(_path, fs::FileOpenMode::read); _contentLength = _content.size(); - if (strlen(contentType) == 0) + if (strlen(contentType) == 0) { _setContentTypeFromPath(path); - else + } else { _contentType = contentType; + } int filenameStart = path.lastIndexOf('/') + 1; char buf[26 + path.length() - filenameStart]; - char* filename = (char*)path.c_str() + filenameStart; + char *filename = (char *)path.c_str() + filenameStart; if (download) { // set filename and force download @@ -669,13 +682,14 @@ AsyncFileResponse::AsyncFileResponse(FS& fs, const String& path, const char* con addHeader(T_Content_Disposition, buf, false); } -AsyncFileResponse::AsyncFileResponse(File content, const String& path, const char* contentType, bool download, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) { +AsyncFileResponse::AsyncFileResponse(File content, const String &path, const char *contentType, bool download, AwsTemplateProcessor callback) + : AsyncAbstractResponse(callback) { _code = 200; _path = path; if (!download && String(content.name()).endsWith(T__gz) && !path.endsWith(T__gz)) { addHeader(T_Content_Encoding, T_gzip, false); - _callback = nullptr; // Unable to process gzipped templates + _callback = nullptr; // Unable to process gzipped templates _sendContentLength = true; _chunked = false; } @@ -683,14 +697,15 @@ AsyncFileResponse::AsyncFileResponse(File content, const String& path, const cha _content = content; _contentLength = _content.size(); - if (strlen(contentType) == 0) + if (strlen(contentType) == 0) { _setContentTypeFromPath(path); - else + } else { _contentType = contentType; + } int filenameStart = path.lastIndexOf('/') + 1; char buf[26 + path.length() - filenameStart]; - char* filename = (char*)path.c_str() + filenameStart; + char *filename = (char *)path.c_str() + filenameStart; if (download) { snprintf_P(buf, sizeof(buf), PSTR("attachment; filename=\"%s\""), filename); @@ -700,7 +715,7 @@ AsyncFileResponse::AsyncFileResponse(File content, const String& path, const cha addHeader(T_Content_Disposition, buf, false); } -size_t AsyncFileResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t AsyncFileResponse::_fillBuffer(uint8_t *data, size_t len) { return _content.read(data, len); } @@ -708,19 +723,20 @@ size_t AsyncFileResponse::_fillBuffer(uint8_t* data, size_t len) { * Stream Response * */ -AsyncStreamResponse::AsyncStreamResponse(Stream& stream, const char* contentType, size_t len, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) { +AsyncStreamResponse::AsyncStreamResponse(Stream &stream, const char *contentType, size_t len, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) { _code = 200; _content = &stream; _contentLength = len; _contentType = contentType; } -size_t AsyncStreamResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t AsyncStreamResponse::_fillBuffer(uint8_t *data, size_t len) { size_t available = _content->available(); size_t outLen = (available > len) ? len : available; size_t i; - for (i = 0; i < outLen; i++) + for (i = 0; i < outLen; i++) { data[i] = _content->read(); + } return outLen; } @@ -728,17 +744,19 @@ size_t AsyncStreamResponse::_fillBuffer(uint8_t* data, size_t len) { * Callback Response * */ -AsyncCallbackResponse::AsyncCallbackResponse(const char* contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback) : AsyncAbstractResponse(templateCallback) { +AsyncCallbackResponse::AsyncCallbackResponse(const char *contentType, size_t len, AwsResponseFiller callback, AwsTemplateProcessor templateCallback) + : AsyncAbstractResponse(templateCallback) { _code = 200; _content = callback; _contentLength = len; - if (!len) + if (!len) { _sendContentLength = false; + } _contentType = contentType; _filledLength = 0; } -size_t AsyncCallbackResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t AsyncCallbackResponse::_fillBuffer(uint8_t *data, size_t len) { size_t ret = _content(data, len, _filledLength); if (ret != RESPONSE_TRY_AGAIN) { _filledLength += ret; @@ -750,7 +768,8 @@ size_t AsyncCallbackResponse::_fillBuffer(uint8_t* data, size_t len) { * Chunked Response * */ -AsyncChunkedResponse::AsyncChunkedResponse(const char* contentType, AwsResponseFiller callback, AwsTemplateProcessor processorCallback) : AsyncAbstractResponse(processorCallback) { +AsyncChunkedResponse::AsyncChunkedResponse(const char *contentType, AwsResponseFiller callback, AwsTemplateProcessor processorCallback) + : AsyncAbstractResponse(processorCallback) { _code = 200; _content = callback; _contentLength = 0; @@ -760,7 +779,7 @@ AsyncChunkedResponse::AsyncChunkedResponse(const char* contentType, AwsResponseF _filledLength = 0; } -size_t AsyncChunkedResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t AsyncChunkedResponse::_fillBuffer(uint8_t *data, size_t len) { size_t ret = _content(data, len, _filledLength); if (ret != RESPONSE_TRY_AGAIN) { _filledLength += ret; @@ -772,7 +791,8 @@ size_t AsyncChunkedResponse::_fillBuffer(uint8_t* data, size_t len) { * Progmem Response * */ -AsyncProgmemResponse::AsyncProgmemResponse(int code, const char* contentType, const uint8_t* content, size_t len, AwsTemplateProcessor callback) : AsyncAbstractResponse(callback) { +AsyncProgmemResponse::AsyncProgmemResponse(int code, const char *contentType, const uint8_t *content, size_t len, AwsTemplateProcessor callback) + : AsyncAbstractResponse(callback) { _code = code; _content = content; _contentType = contentType; @@ -780,7 +800,7 @@ AsyncProgmemResponse::AsyncProgmemResponse(int code, const char* contentType, co _readLength = 0; } -size_t AsyncProgmemResponse::_fillBuffer(uint8_t* data, size_t len) { +size_t AsyncProgmemResponse::_fillBuffer(uint8_t *data, size_t len) { size_t left = _contentLength - _readLength; if (left > len) { memcpy_P(data, _content + _readLength, len); @@ -796,20 +816,25 @@ size_t AsyncProgmemResponse::_fillBuffer(uint8_t* data, size_t len) { * Response Stream (You can print/write/printf to it, up to the contentLen bytes) * */ -AsyncResponseStream::AsyncResponseStream(const char* contentType, size_t bufferSize) { +AsyncResponseStream::AsyncResponseStream(const char *contentType, size_t bufferSize) { _code = 200; _contentLength = 0; _contentType = contentType; - _content.reserve(bufferSize); + if (!_content.reserve(bufferSize)) { +#ifdef ESP32 + log_e("Failed to allocate"); +#endif + } } -size_t AsyncResponseStream::_fillBuffer(uint8_t* buf, size_t maxLen) { - return _content.readBytes((char*)buf, maxLen); +size_t AsyncResponseStream::_fillBuffer(uint8_t *buf, size_t maxLen) { + return _content.readBytes((char *)buf, maxLen); } -size_t AsyncResponseStream::write(const uint8_t* data, size_t len) { - if (_started()) +size_t AsyncResponseStream::write(const uint8_t *data, size_t len) { + if (_started()) { return 0; + } size_t written = _content.write(data, len); _contentLength += written; return written; diff --git a/src/WebServer.cpp b/src/WebServer.cpp index ebf126a..7fc54bf 100644 --- a/src/WebServer.cpp +++ b/src/WebServer.cpp @@ -1,29 +1,12 @@ -/* - Asynchronous WebServer library for Espressif MCUs +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov - Copyright (c) 2016 Hristo Gochkov. All rights reserved. - This file is part of the esp8266 core for Arduino environment. - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -*/ #include "ESPAsyncWebServer.h" #include "WebHandlerImpl.h" using namespace asyncsrv; -bool ON_STA_FILTER(AsyncWebServerRequest* request) { +bool ON_STA_FILTER(AsyncWebServerRequest *request) { #ifndef CONFIG_IDF_TARGET_ESP32H2 return WiFi.localIP() == request->client()->localIP(); #else @@ -31,7 +14,7 @@ bool ON_STA_FILTER(AsyncWebServerRequest* request) { #endif } -bool ON_AP_FILTER(AsyncWebServerRequest* request) { +bool ON_AP_FILTER(AsyncWebServerRequest *request) { #ifndef CONFIG_IDF_TARGET_ESP32H2 return WiFi.localIP() != request->client()->localIP(); #else @@ -40,51 +23,51 @@ bool ON_AP_FILTER(AsyncWebServerRequest* request) { } #ifndef HAVE_FS_FILE_OPEN_MODE -const char* fs::FileOpenMode::read = "r"; -const char* fs::FileOpenMode::write = "w"; -const char* fs::FileOpenMode::append = "a"; +const char *fs::FileOpenMode::read = "r"; +const char *fs::FileOpenMode::write = "w"; +const char *fs::FileOpenMode::append = "a"; #endif -AsyncWebServer::AsyncWebServer(uint16_t port) - : _server(port) { +AsyncWebServer::AsyncWebServer(uint16_t port) : _server(port) { _catchAllHandler = new AsyncCallbackWebHandler(); - if (_catchAllHandler == NULL) - return; - _server.onClient([](void* s, AsyncClient* c) { - if (c == NULL) - return; - c->setRxTimeout(3); - AsyncWebServerRequest* r = new AsyncWebServerRequest((AsyncWebServer*)s, c); - if (r == NULL) { - c->abort(); - delete c; - } - }, - this); + _server.onClient( + [](void *s, AsyncClient *c) { + if (c == NULL) { + return; + } + c->setRxTimeout(3); + AsyncWebServerRequest *r = new AsyncWebServerRequest((AsyncWebServer *)s, c); + if (r == NULL) { + c->abort(); + delete c; + } + }, + this + ); } AsyncWebServer::~AsyncWebServer() { reset(); end(); - if (_catchAllHandler) - delete _catchAllHandler; + delete _catchAllHandler; + _catchAllHandler = nullptr; // Prevent potential use-after-free } -AsyncWebRewrite& AsyncWebServer::addRewrite(std::shared_ptr rewrite) { +AsyncWebRewrite &AsyncWebServer::addRewrite(std::shared_ptr rewrite) { _rewrites.emplace_back(rewrite); return *_rewrites.back().get(); } -AsyncWebRewrite& AsyncWebServer::addRewrite(AsyncWebRewrite* rewrite) { +AsyncWebRewrite &AsyncWebServer::addRewrite(AsyncWebRewrite *rewrite) { _rewrites.emplace_back(rewrite); return *_rewrites.back().get(); } -bool AsyncWebServer::removeRewrite(AsyncWebRewrite* rewrite) { +bool AsyncWebServer::removeRewrite(AsyncWebRewrite *rewrite) { return removeRewrite(rewrite->from().c_str(), rewrite->toUrl().c_str()); } -bool AsyncWebServer::removeRewrite(const char* from, const char* to) { +bool AsyncWebServer::removeRewrite(const char *from, const char *to) { for (auto r = _rewrites.begin(); r != _rewrites.end(); ++r) { if (r->get()->from() == from && r->get()->toUrl() == to) { _rewrites.erase(r); @@ -94,17 +77,17 @@ bool AsyncWebServer::removeRewrite(const char* from, const char* to) { return false; } -AsyncWebRewrite& AsyncWebServer::rewrite(const char* from, const char* to) { +AsyncWebRewrite &AsyncWebServer::rewrite(const char *from, const char *to) { _rewrites.emplace_back(std::make_shared(from, to)); return *_rewrites.back().get(); } -AsyncWebHandler& AsyncWebServer::addHandler(AsyncWebHandler* handler) { +AsyncWebHandler &AsyncWebServer::addHandler(AsyncWebHandler *handler) { _handlers.emplace_back(handler); return *(_handlers.back().get()); } -bool AsyncWebServer::removeHandler(AsyncWebHandler* handler) { +bool AsyncWebServer::removeHandler(AsyncWebHandler *handler) { for (auto i = _handlers.begin(); i != _handlers.end(); ++i) { if (i->get() == handler) { _handlers.erase(i); @@ -124,21 +107,23 @@ void AsyncWebServer::end() { } #if ASYNC_TCP_SSL_ENABLED -void AsyncWebServer::onSslFileRequest(AcSSlFileHandler cb, void* arg) { +void AsyncWebServer::onSslFileRequest(AcSSlFileHandler cb, void *arg) { _server.onSslFileRequest(cb, arg); } -void AsyncWebServer::beginSecure(const char* cert, const char* key, const char* password) { +void AsyncWebServer::beginSecure(const char *cert, const char *key, const char *password) { _server.beginSecure(cert, key, password); } #endif -void AsyncWebServer::_handleDisconnect(AsyncWebServerRequest* request) { +void AsyncWebServer::_handleDisconnect(AsyncWebServerRequest *request) { delete request; } -void AsyncWebServer::_rewriteRequest(AsyncWebServerRequest* request) { - for (const auto& r : _rewrites) { +void AsyncWebServer::_rewriteRequest(AsyncWebServerRequest *request) { + // the last rewrite that matches the request will be used + // we do not break the loop to allow for multiple rewrites to be applied and only the last one to be used (allows overriding) + for (const auto &r : _rewrites) { if (r->match(request)) { request->_url = r->toUrl(); request->_addGetParams(r->params()); @@ -146,19 +131,21 @@ void AsyncWebServer::_rewriteRequest(AsyncWebServerRequest* request) { } } -void AsyncWebServer::_attachHandler(AsyncWebServerRequest* request) { - for (auto& h : _handlers) { +void AsyncWebServer::_attachHandler(AsyncWebServerRequest *request) { + for (auto &h : _handlers) { if (h->filter(request) && h->canHandle(request)) { request->setHandler(h.get()); return; } } - + // ESP_LOGD("AsyncWebServer", "No handler found for %s, using _catchAllHandler pointer: %p", request->url().c_str(), _catchAllHandler); request->setHandler(_catchAllHandler); } -AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload, ArBodyHandlerFunction onBody) { - AsyncCallbackWebHandler* handler = new AsyncCallbackWebHandler(); +AsyncCallbackWebHandler &AsyncWebServer::on( + const char *uri, WebRequestMethodComposite method, ArRequestHandlerFunction onRequest, ArUploadHandlerFunction onUpload, ArBodyHandlerFunction onBody +) { + AsyncCallbackWebHandler *handler = new AsyncCallbackWebHandler(); handler->setUri(uri); handler->setMethod(method); handler->onRequest(onRequest); @@ -168,8 +155,8 @@ AsyncCallbackWebHandler& AsyncWebServer::on(const char* uri, WebRequestMethodCom return *handler; } -AsyncStaticWebHandler& AsyncWebServer::serveStatic(const char* uri, fs::FS& fs, const char* path, const char* cache_control) { - AsyncStaticWebHandler* handler = new AsyncStaticWebHandler(uri, fs, path, cache_control); +AsyncStaticWebHandler &AsyncWebServer::serveStatic(const char *uri, fs::FS &fs, const char *path, const char *cache_control) { + AsyncStaticWebHandler *handler = new AsyncStaticWebHandler(uri, fs, path, cache_control); addHandler(handler); return *handler; } @@ -186,13 +173,15 @@ void AsyncWebServer::onRequestBody(ArBodyHandlerFunction fn) { _catchAllHandler->onBody(fn); } +AsyncWebHandler &AsyncWebServer::catchAllHandler() const { + return *_catchAllHandler; +} + void AsyncWebServer::reset() { _rewrites.clear(); _handlers.clear(); - if (_catchAllHandler != NULL) { - _catchAllHandler->onRequest(NULL); - _catchAllHandler->onUpload(NULL); - _catchAllHandler->onBody(NULL); - } + _catchAllHandler->onRequest(NULL); + _catchAllHandler->onUpload(NULL); + _catchAllHandler->onBody(NULL); } diff --git a/src/literals.h b/src/literals.h index e924483..a69f78b 100644 --- a/src/literals.h +++ b/src/literals.h @@ -1,183 +1,193 @@ +// SPDX-License-Identifier: LGPL-3.0-or-later +// Copyright 2016-2025 Hristo Gochkov, Mathieu Carbou, Emil Muratov + #pragma once namespace asyncsrv { - static constexpr const char* empty = ""; +static constexpr const char *empty = ""; - static constexpr const char* T__opaque = "\", opaque=\""; - static constexpr const char* T_100_CONTINUE = "100-continue"; - static constexpr const char* T_13 = "13"; - static constexpr const char* T_ACCEPT = "accept"; - static constexpr const char* T_Accept_Ranges = "accept-ranges"; - static constexpr const char* T_app_xform_urlencoded = "application/x-www-form-urlencoded"; - static constexpr const char* T_AUTH = "authorization"; - static constexpr const char* T_auth_nonce = "\", qop=\"auth\", nonce=\""; - static constexpr const char* T_BASIC = "basic"; - static constexpr const char* T_BASIC_REALM = "basic realm=\""; - static constexpr const char* T_BEARER = "bearer"; - static constexpr const char* T_BODY = "body"; - static constexpr const char* T_Cache_Control = "cache-control"; - static constexpr const char* T_chunked = "chunked"; - static constexpr const char* T_close = "close"; - static constexpr const char* T_cnonce = "cnonce"; - static constexpr const char* T_Connection = "connection"; - static constexpr const char* T_Content_Disposition = "content-disposition"; - static constexpr const char* T_Content_Encoding = "content-encoding"; - static constexpr const char* T_Content_Length = "content-length"; - static constexpr const char* T_Content_Type = "content-type"; - static constexpr const char* T_Cookie = "cookie"; - static constexpr const char* T_CORS_ACAC = "access-control-allow-credentials"; - static constexpr const char* T_CORS_ACAH = "access-control-allow-headers"; - static constexpr const char* T_CORS_ACAM = "access-control-allow-methods"; - static constexpr const char* T_CORS_ACAO = "access-control-allow-origin"; - static constexpr const char* T_CORS_ACMA = "access-control-max-age"; - static constexpr const char* T_CORS_O = "origin"; - static constexpr const char* T_data_ = "data: "; - static constexpr const char* T_DIGEST = "digest"; - static constexpr const char* T_DIGEST_ = "digest "; - static constexpr const char* T_ETag = "etag"; - static constexpr const char* T_event_ = "event: "; - static constexpr const char* T_EXPECT = "expect"; - static constexpr const char* T_FALSE = "false"; - static constexpr const char* T_filename = "filename"; - static constexpr const char* T_gzip = "gzip"; - static constexpr const char* T_Host = "host"; - static constexpr const char* T_HTTP_1_0 = "HTTP/1.0"; - static constexpr const char* T_HTTP_100_CONT = "HTTP/1.1 100 Continue\r\n\r\n"; - static constexpr const char* T_id__ = "id: "; - static constexpr const char* T_IMS = "if-modified-since"; - static constexpr const char* T_INM = "if-none-match"; - static constexpr const char* T_keep_alive = "keep-alive"; - static constexpr const char* T_Last_Event_ID = "last-event-id"; - static constexpr const char* T_Last_Modified = "last-modified"; - static constexpr const char* T_LOCATION = "location"; - static constexpr const char* T_LOGIN_REQ = "Login Required"; - static constexpr const char* T_MULTIPART_ = "multipart/"; - static constexpr const char* T_name = "name"; - static constexpr const char* T_nc = "nc"; - static constexpr const char* T_no_cache = "no-cache"; - static constexpr const char* T_nonce = "nonce"; - static constexpr const char* T_none = "none"; - static constexpr const char* T_opaque = "opaque"; - static constexpr const char* T_qop = "qop"; - static constexpr const char* T_realm = "realm"; - static constexpr const char* T_realm__ = "realm=\""; - static constexpr const char* T_response = "response"; - static constexpr const char* T_retry_ = "retry: "; - static constexpr const char* T_retry_after = "retry-after"; - static constexpr const char* T_nn = "\n\n"; - static constexpr const char* T_rn = "\r\n"; - static constexpr const char* T_rnrn = "\r\n\r\n"; - static constexpr const char* T_Transfer_Encoding = "transfer-encoding"; - static constexpr const char* T_TRUE = "true"; - static constexpr const char* T_UPGRADE = "upgrade"; - static constexpr const char* T_uri = "uri"; - static constexpr const char* T_username = "username"; - static constexpr const char* T_WS = "websocket"; - static constexpr const char* T_WWW_AUTH = "www-authenticate"; +static constexpr const char *T__opaque = "\", opaque=\""; +static constexpr const char *T_100_CONTINUE = "100-continue"; +static constexpr const char *T_13 = "13"; +static constexpr const char *T_ACCEPT = "accept"; +static constexpr const char *T_Accept_Ranges = "accept-ranges"; +static constexpr const char *T_app_xform_urlencoded = "application/x-www-form-urlencoded"; +static constexpr const char *T_AUTH = "authorization"; +static constexpr const char *T_auth_nonce = "\", qop=\"auth\", nonce=\""; +static constexpr const char *T_BASIC = "basic"; +static constexpr const char *T_BASIC_REALM = "basic realm=\""; +static constexpr const char *T_BEARER = "bearer"; +static constexpr const char *T_BODY = "body"; +static constexpr const char *T_Cache_Control = "cache-control"; +static constexpr const char *T_chunked = "chunked"; +static constexpr const char *T_close = "close"; +static constexpr const char *T_cnonce = "cnonce"; +static constexpr const char *T_Connection = "connection"; +static constexpr const char *T_Content_Disposition = "content-disposition"; +static constexpr const char *T_Content_Encoding = "content-encoding"; +static constexpr const char *T_Content_Length = "content-length"; +static constexpr const char *T_Content_Type = "content-type"; +static constexpr const char *T_Content_Location = "content-location"; +static constexpr const char *T_Cookie = "cookie"; +static constexpr const char *T_CORS_ACAC = "access-control-allow-credentials"; +static constexpr const char *T_CORS_ACAH = "access-control-allow-headers"; +static constexpr const char *T_CORS_ACAM = "access-control-allow-methods"; +static constexpr const char *T_CORS_ACAO = "access-control-allow-origin"; +static constexpr const char *T_CORS_ACMA = "access-control-max-age"; +static constexpr const char *T_CORS_O = "origin"; +static constexpr const char *T_data_ = "data: "; +static constexpr const char *T_Date = "date"; +static constexpr const char *T_DIGEST = "digest"; +static constexpr const char *T_DIGEST_ = "digest "; +static constexpr const char *T_ETag = "etag"; +static constexpr const char *T_event_ = "event: "; +static constexpr const char *T_EXPECT = "expect"; +static constexpr const char *T_FALSE = "false"; +static constexpr const char *T_filename = "filename"; +static constexpr const char *T_gzip = "gzip"; +static constexpr const char *T_Host = "host"; +static constexpr const char *T_HTTP_1_0 = "HTTP/1.0"; +static constexpr const char *T_HTTP_100_CONT = "HTTP/1.1 100 Continue\r\n\r\n"; +static constexpr const char *T_id__ = "id: "; +static constexpr const char *T_IMS = "if-modified-since"; +static constexpr const char *T_INM = "if-none-match"; +static constexpr const char *T_keep_alive = "keep-alive"; +static constexpr const char *T_Last_Event_ID = "last-event-id"; +static constexpr const char *T_Last_Modified = "last-modified"; +static constexpr const char *T_LOCATION = "location"; +static constexpr const char *T_LOGIN_REQ = "Login Required"; +static constexpr const char *T_MULTIPART_ = "multipart/"; +static constexpr const char *T_name = "name"; +static constexpr const char *T_nc = "nc"; +static constexpr const char *T_no_cache = "no-cache"; +static constexpr const char *T_nonce = "nonce"; +static constexpr const char *T_none = "none"; +static constexpr const char *T_opaque = "opaque"; +static constexpr const char *T_qop = "qop"; +static constexpr const char *T_realm = "realm"; +static constexpr const char *T_realm__ = "realm=\""; +static constexpr const char *T_response = "response"; +static constexpr const char *T_retry_ = "retry: "; +static constexpr const char *T_retry_after = "retry-after"; +static constexpr const char *T_nn = "\n\n"; +static constexpr const char *T_rn = "\r\n"; +static constexpr const char *T_rnrn = "\r\n\r\n"; +static constexpr const char *T_Server = "server"; +static constexpr const char *T_Transfer_Encoding = "transfer-encoding"; +static constexpr const char *T_TRUE = "true"; +static constexpr const char *T_UPGRADE = "upgrade"; +static constexpr const char *T_uri = "uri"; +static constexpr const char *T_username = "username"; +static constexpr const char *T_WS = "websocket"; +static constexpr const char *T_WWW_AUTH = "www-authenticate"; - // HTTP Methods +// HTTP Methods - static constexpr const char* T_ANY = "ANY"; - static constexpr const char* T_GET = "GET"; - static constexpr const char* T_POST = "POST"; - static constexpr const char* T_PUT = "PUT"; - static constexpr const char* T_DELETE = "DELETE"; - static constexpr const char* T_PATCH = "PATCH"; - static constexpr const char* T_HEAD = "HEAD"; - static constexpr const char* T_OPTIONS = "OPTIONS"; - static constexpr const char* T_UNKNOWN = "UNKNOWN"; +static constexpr const char *T_ANY = "ANY"; +static constexpr const char *T_GET = "GET"; +static constexpr const char *T_POST = "POST"; +static constexpr const char *T_PUT = "PUT"; +static constexpr const char *T_DELETE = "DELETE"; +static constexpr const char *T_PATCH = "PATCH"; +static constexpr const char *T_HEAD = "HEAD"; +static constexpr const char *T_OPTIONS = "OPTIONS"; +static constexpr const char *T_UNKNOWN = "UNKNOWN"; - // Req content types - static constexpr const char* T_RCT_NOT_USED = "RCT_NOT_USED"; - static constexpr const char* T_RCT_DEFAULT = "RCT_DEFAULT"; - static constexpr const char* T_RCT_HTTP = "RCT_HTTP"; - static constexpr const char* T_RCT_WS = "RCT_WS"; - static constexpr const char* T_RCT_EVENT = "RCT_EVENT"; - static constexpr const char* T_ERROR = "ERROR"; +// Req content types +static constexpr const char *T_RCT_NOT_USED = "RCT_NOT_USED"; +static constexpr const char *T_RCT_DEFAULT = "RCT_DEFAULT"; +static constexpr const char *T_RCT_HTTP = "RCT_HTTP"; +static constexpr const char *T_RCT_WS = "RCT_WS"; +static constexpr const char *T_RCT_EVENT = "RCT_EVENT"; +static constexpr const char *T_ERROR = "ERROR"; - // extentions & MIME-Types - static constexpr const char* T__css = ".css"; - static constexpr const char* T__eot = ".eot"; - static constexpr const char* T__gif = ".gif"; - static constexpr const char* T__gz = ".gz"; - static constexpr const char* T__htm = ".htm"; - static constexpr const char* T__html = ".html"; - static constexpr const char* T__ico = ".ico"; - static constexpr const char* T__jpg = ".jpg"; - static constexpr const char* T__js = ".js"; - static constexpr const char* T__json = ".json"; - static constexpr const char* T__pdf = ".pdf"; - static constexpr const char* T__png = ".png"; - static constexpr const char* T__svg = ".svg"; - static constexpr const char* T__ttf = ".ttf"; - static constexpr const char* T__woff = ".woff"; - static constexpr const char* T__woff2 = ".woff2"; - static constexpr const char* T__xml = ".xml"; - static constexpr const char* T__zip = ".zip"; - static constexpr const char* T_application_javascript = "application/javascript"; - static constexpr const char* T_application_json = "application/json"; - static constexpr const char* T_application_msgpack = "application/msgpack"; - static constexpr const char* T_application_pdf = "application/pdf"; - static constexpr const char* T_application_x_gzip = "application/x-gzip"; - static constexpr const char* T_application_zip = "application/zip"; - static constexpr const char* T_font_eot = "font/eot"; - static constexpr const char* T_font_ttf = "font/ttf"; - static constexpr const char* T_font_woff = "font/woff"; - static constexpr const char* T_font_woff2 = "font/woff2"; - static constexpr const char* T_image_gif = "image/gif"; - static constexpr const char* T_image_jpeg = "image/jpeg"; - static constexpr const char* T_image_png = "image/png"; - static constexpr const char* T_image_svg_xml = "image/svg+xml"; - static constexpr const char* T_image_x_icon = "image/x-icon"; - static constexpr const char* T_text_css = "text/css"; - static constexpr const char* T_text_event_stream = "text/event-stream"; - static constexpr const char* T_text_html = "text/html"; - static constexpr const char* T_text_plain = "text/plain"; - static constexpr const char* T_text_xml = "text/xml"; +// extensions & MIME-Types +static constexpr const char *T__css = ".css"; +static constexpr const char *T__eot = ".eot"; +static constexpr const char *T__gif = ".gif"; +static constexpr const char *T__gz = ".gz"; +static constexpr const char *T__htm = ".htm"; +static constexpr const char *T__html = ".html"; +static constexpr const char *T__ico = ".ico"; +static constexpr const char *T__jpg = ".jpg"; +static constexpr const char *T__js = ".js"; +static constexpr const char *T__json = ".json"; +static constexpr const char *T__pdf = ".pdf"; +static constexpr const char *T__png = ".png"; +static constexpr const char *T__svg = ".svg"; +static constexpr const char *T__ttf = ".ttf"; +static constexpr const char *T__woff = ".woff"; +static constexpr const char *T__woff2 = ".woff2"; +static constexpr const char *T__xml = ".xml"; +static constexpr const char *T__zip = ".zip"; +static constexpr const char *T_application_javascript = "application/javascript"; +static constexpr const char *T_application_json = "application/json"; +static constexpr const char *T_application_msgpack = "application/msgpack"; +static constexpr const char *T_application_pdf = "application/pdf"; +static constexpr const char *T_application_x_gzip = "application/x-gzip"; +static constexpr const char *T_application_zip = "application/zip"; +static constexpr const char *T_font_eot = "font/eot"; +static constexpr const char *T_font_ttf = "font/ttf"; +static constexpr const char *T_font_woff = "font/woff"; +static constexpr const char *T_font_woff2 = "font/woff2"; +static constexpr const char *T_image_gif = "image/gif"; +static constexpr const char *T_image_jpeg = "image/jpeg"; +static constexpr const char *T_image_png = "image/png"; +static constexpr const char *T_image_svg_xml = "image/svg+xml"; +static constexpr const char *T_image_x_icon = "image/x-icon"; +static constexpr const char *T_text_css = "text/css"; +static constexpr const char *T_text_event_stream = "text/event-stream"; +static constexpr const char *T_text_html = "text/html"; +static constexpr const char *T_text_plain = "text/plain"; +static constexpr const char *T_text_xml = "text/xml"; - // Responce codes - static constexpr const char* T_HTTP_CODE_100 = "Continue"; - static constexpr const char* T_HTTP_CODE_101 = "Switching Protocols"; - static constexpr const char* T_HTTP_CODE_200 = "OK"; - static constexpr const char* T_HTTP_CODE_201 = "Created"; - static constexpr const char* T_HTTP_CODE_202 = "Accepted"; - static constexpr const char* T_HTTP_CODE_203 = "Non-Authoritative Information"; - static constexpr const char* T_HTTP_CODE_204 = "No Content"; - static constexpr const char* T_HTTP_CODE_205 = "Reset Content"; - static constexpr const char* T_HTTP_CODE_206 = "Partial Content"; - static constexpr const char* T_HTTP_CODE_300 = "Multiple Choices"; - static constexpr const char* T_HTTP_CODE_301 = "Moved Permanently"; - static constexpr const char* T_HTTP_CODE_302 = "Found"; - static constexpr const char* T_HTTP_CODE_303 = "See Other"; - static constexpr const char* T_HTTP_CODE_304 = "Not Modified"; - static constexpr const char* T_HTTP_CODE_305 = "Use Proxy"; - static constexpr const char* T_HTTP_CODE_307 = "Temporary Redirect"; - static constexpr const char* T_HTTP_CODE_400 = "Bad Request"; - static constexpr const char* T_HTTP_CODE_401 = "Unauthorized"; - static constexpr const char* T_HTTP_CODE_402 = "Payment Required"; - static constexpr const char* T_HTTP_CODE_403 = "Forbidden"; - static constexpr const char* T_HTTP_CODE_404 = "Not Found"; - static constexpr const char* T_HTTP_CODE_405 = "Method Not Allowed"; - static constexpr const char* T_HTTP_CODE_406 = "Not Acceptable"; - static constexpr const char* T_HTTP_CODE_407 = "Proxy Authentication Required"; - static constexpr const char* T_HTTP_CODE_408 = "Request Time-out"; - static constexpr const char* T_HTTP_CODE_409 = "Conflict"; - static constexpr const char* T_HTTP_CODE_410 = "Gone"; - static constexpr const char* T_HTTP_CODE_411 = "Length Required"; - static constexpr const char* T_HTTP_CODE_412 = "Precondition Failed"; - static constexpr const char* T_HTTP_CODE_413 = "Request Entity Too Large"; - static constexpr const char* T_HTTP_CODE_414 = "Request-URI Too Large"; - static constexpr const char* T_HTTP_CODE_415 = "Unsupported Media Type"; - static constexpr const char* T_HTTP_CODE_416 = "Requested range not satisfiable"; - static constexpr const char* T_HTTP_CODE_417 = "Expectation Failed"; - static constexpr const char* T_HTTP_CODE_429 = "Too Many Requests"; - static constexpr const char* T_HTTP_CODE_500 = "Internal Server Error"; - static constexpr const char* T_HTTP_CODE_501 = "Not Implemented"; - static constexpr const char* T_HTTP_CODE_502 = "Bad Gateway"; - static constexpr const char* T_HTTP_CODE_503 = "Service Unavailable"; - static constexpr const char* T_HTTP_CODE_504 = "Gateway Time-out"; - static constexpr const char* T_HTTP_CODE_505 = "HTTP Version not supported"; - static constexpr const char* T_HTTP_CODE_ANY = "Unknown code"; +// Response codes +static constexpr const char *T_HTTP_CODE_100 = "Continue"; +static constexpr const char *T_HTTP_CODE_101 = "Switching Protocols"; +static constexpr const char *T_HTTP_CODE_200 = "OK"; +static constexpr const char *T_HTTP_CODE_201 = "Created"; +static constexpr const char *T_HTTP_CODE_202 = "Accepted"; +static constexpr const char *T_HTTP_CODE_203 = "Non-Authoritative Information"; +static constexpr const char *T_HTTP_CODE_204 = "No Content"; +static constexpr const char *T_HTTP_CODE_205 = "Reset Content"; +static constexpr const char *T_HTTP_CODE_206 = "Partial Content"; +static constexpr const char *T_HTTP_CODE_300 = "Multiple Choices"; +static constexpr const char *T_HTTP_CODE_301 = "Moved Permanently"; +static constexpr const char *T_HTTP_CODE_302 = "Found"; +static constexpr const char *T_HTTP_CODE_303 = "See Other"; +static constexpr const char *T_HTTP_CODE_304 = "Not Modified"; +static constexpr const char *T_HTTP_CODE_305 = "Use Proxy"; +static constexpr const char *T_HTTP_CODE_307 = "Temporary Redirect"; +static constexpr const char *T_HTTP_CODE_400 = "Bad Request"; +static constexpr const char *T_HTTP_CODE_401 = "Unauthorized"; +static constexpr const char *T_HTTP_CODE_402 = "Payment Required"; +static constexpr const char *T_HTTP_CODE_403 = "Forbidden"; +static constexpr const char *T_HTTP_CODE_404 = "Not Found"; +static constexpr const char *T_HTTP_CODE_405 = "Method Not Allowed"; +static constexpr const char *T_HTTP_CODE_406 = "Not Acceptable"; +static constexpr const char *T_HTTP_CODE_407 = "Proxy Authentication Required"; +static constexpr const char *T_HTTP_CODE_408 = "Request Time-out"; +static constexpr const char *T_HTTP_CODE_409 = "Conflict"; +static constexpr const char *T_HTTP_CODE_410 = "Gone"; +static constexpr const char *T_HTTP_CODE_411 = "Length Required"; +static constexpr const char *T_HTTP_CODE_412 = "Precondition Failed"; +static constexpr const char *T_HTTP_CODE_413 = "Request Entity Too Large"; +static constexpr const char *T_HTTP_CODE_414 = "Request-URI Too Large"; +static constexpr const char *T_HTTP_CODE_415 = "Unsupported Media Type"; +static constexpr const char *T_HTTP_CODE_416 = "Requested range not satisfiable"; +static constexpr const char *T_HTTP_CODE_417 = "Expectation Failed"; +static constexpr const char *T_HTTP_CODE_429 = "Too Many Requests"; +static constexpr const char *T_HTTP_CODE_500 = "Internal Server Error"; +static constexpr const char *T_HTTP_CODE_501 = "Not Implemented"; +static constexpr const char *T_HTTP_CODE_502 = "Bad Gateway"; +static constexpr const char *T_HTTP_CODE_503 = "Service Unavailable"; +static constexpr const char *T_HTTP_CODE_504 = "Gateway Time-out"; +static constexpr const char *T_HTTP_CODE_505 = "HTTP Version not supported"; +static constexpr const char *T_HTTP_CODE_ANY = "Unknown code"; -} // namespace asyncsrv {} +static constexpr const uint8_t T_only_once_headers_len = 11; +static constexpr const char *T_only_once_headers[] = {T_Content_Length, T_Content_Type, T_Date, T_ETag, T_Last_Modified, T_LOCATION, T_retry_after, + T_Transfer_Encoding, T_Content_Location, T_Server, T_WWW_AUTH}; + +} // namespace asyncsrv