mirror of
https://github.com/xoseperez/espurna.git
synced 2026-03-14 20:27:09 +01:00
8e80a7786c
- match paths through a custom AsyncWebHandler instead of using generic not-found fallback handler - allow MQTT-like patterns when registering paths (`simple/path`, `path/+/something`, `path/#`) Replaces `relay/0`, `relay/1` etc. with `relay/+`. Magnitudes are plain paths, but using `/+` in case there's more than 1 magnitude of the same type. - restore `std::function` as callback container (no more single-byte arg nonsense). Still, limit to 1 type per handler type - adds JSON handlers which will receive JsonObject root as both input and output. Same logic as plain - GET returns resource data, PUT updates it. - breaking change to `apiAuthenticate(request)`, it no longer will do `request->send(403)` and expect this to be handled externally. - allow `Api-Key` header containing the key, works for both GET & PUT plain requests. The only way to set apikey for JSON. - add `ApiRequest::param` to retrieve both GET and PUT params (aka args), remove ApiBuffer - remove `API_BUFFER_SIZE`. Allow custom form-data key=value pairs for requests, allow to send basic `String`. - add `API_JSON_BUFFER_SIZE` for the JSON buffer (both input and output) - `/apis` replaced with `/api/list`, no longer uses custom handler and is an `apiRegister` callback - `/api/rpc` custom handler replaced with an `apiRegister` callback WIP further down: - no more `webLog` for API requests, unless `webAccessLog` / `WEB_ACCESS_LOG` is set to `1`. This also needs to happen to the other handlers. - migrate to ArduinoJson v6, since it become apparent it is actually a good upgrade :) - actually make use of JSON endpoints more, right now it's just existing GET for sensors and relays - fork ESPAsyncWebServer to cleanup path parsing and temporary objects attached to the request (also, fix things a lot of things based on PRs there...)
95 lines
2.3 KiB
C++
95 lines
2.3 KiB
C++
/*
|
|
|
|
WEBSERVER MODULE
|
|
|
|
Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com>
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "espurna.h"
|
|
|
|
#if WEB_SUPPORT
|
|
|
|
#include <functional>
|
|
#include <list>
|
|
#include <vector>
|
|
|
|
#include <ESPAsyncWebServer.h>
|
|
|
|
struct AsyncWebPrintConfig {
|
|
const char* const mimeType;
|
|
const size_t backlogCountMax;
|
|
const size_t backlogSizeMax;
|
|
const decltype(millis()) backlogTimeout;
|
|
};
|
|
|
|
struct AsyncWebPrint : public Print {
|
|
|
|
enum class State {
|
|
None,
|
|
Sending,
|
|
Done,
|
|
Error
|
|
};
|
|
|
|
using BufferType = std::vector<uint8_t>;
|
|
|
|
// To be able to safely output data right from the request callback,
|
|
// we schedule a 'printer' task that will print into the request response buffer via AsyncChunkedResponse
|
|
// Note: implementation must be included in the header
|
|
template<typename CallbackType>
|
|
static void scheduleFromRequest(const AsyncWebPrintConfig& config, AsyncWebServerRequest*, CallbackType);
|
|
|
|
template<typename CallbackType>
|
|
static void scheduleFromRequest(AsyncWebServerRequest*, CallbackType);
|
|
|
|
State getState();
|
|
void setState(State);
|
|
|
|
// note: existing implementation only expects this to be available via AsyncWebPrint
|
|
#if defined(ARDUINO_ESP8266_RELEASE_2_3_0)
|
|
void flush();
|
|
#else
|
|
void flush() final override;
|
|
#endif
|
|
|
|
size_t write(uint8_t) final override;
|
|
size_t write(const uint8_t *buffer, size_t size) final override;
|
|
|
|
const char* const mimeType;
|
|
const size_t backlogCountMax;
|
|
const size_t backlogSizeMax;
|
|
const decltype(millis()) backlogTimeout;
|
|
|
|
protected:
|
|
|
|
std::list<BufferType> _buffers;
|
|
AsyncWebServerRequest* const _request;
|
|
State _state;
|
|
|
|
AsyncWebPrint(const AsyncWebPrintConfig&, AsyncWebServerRequest* req);
|
|
|
|
bool _addBuffer();
|
|
bool _exhaustBuffers();
|
|
void _prepareRequest();
|
|
|
|
};
|
|
|
|
using web_body_callback_f = std::function<bool(AsyncWebServerRequest*, uint8_t* data, size_t len, size_t index, size_t total)>;
|
|
using web_request_callback_f = std::function<bool(AsyncWebServerRequest*)>;
|
|
|
|
AsyncWebServer& webServer();
|
|
|
|
bool webAuthenticate(AsyncWebServerRequest *request);
|
|
void webLog(AsyncWebServerRequest *request);
|
|
|
|
void webBodyRegister(web_body_callback_f);
|
|
void webRequestRegister(web_request_callback_f);
|
|
|
|
uint16_t webPort();
|
|
void webSetup();
|
|
|
|
#endif // WEB_SUPPORT == 1
|