arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-10-19 21:09:48 +03:00
Code Activity

Implemented support for filters and removable routes in ESP8266WebServer (#9152)

Browse Source 
* feat: added filters and removeable routes

* Update Filters.ino

* fix: clang-format

* chore: updated docs

* chore: updated doc

* fix: use new implementation

* fix: filters.ino example

* fix: filters.ino

* fix: formatting

* fix: formatting (2)
This commit is contained in:
Ayush Sharma
2024-06-15 23:50:13 +05:30
committed by GitHub
parent 685f2c97ff
commit 9afeaf5694
7 changed files with 317 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
libraries/ESP8266WebServer/src/detail/RequestHandler.h
View File

@@ -12,13 +12,60 @@ class RequestHandler {
using WebServerType = ESP8266WebServerTemplate<ServerType>;
public:
virtual ~RequestHandler() { }
virtual bool canHandle(HTTPMethod method, const String& uri) { (void) method; (void) uri; return false; }
virtual bool canUpload(const String& uri) { (void) uri; return false; }
virtual bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) { (void) server; (void) requestMethod; (void) requestUri; return false; }
virtual void upload(WebServerType& server, const String& requestUri, HTTPUpload& upload) { (void) server; (void) requestUri; (void) upload; }
RequestHandler<ServerType>* next() { return _next; }
void next(RequestHandler<ServerType>* r) { _next = r; }
/*
note: old handler API for backward compatibility
*/
virtual bool canHandle(HTTPMethod method, const String& uri) {
(void) method;
(void) uri;
return false;
}
virtual bool canUpload(const String& uri) {
(void) uri;
return false;
}
/*
note: new handler API with support for filters etc.
*/
virtual bool canHandle(WebServerType& server, HTTPMethod method, const String& uri) {
(void) server;
(void) method;
(void) uri;
return false;
}
virtual bool canUpload(WebServerType& server, const String& uri) {
(void) server;
(void) uri;
return false;
}
virtual bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) {
(void) server;
(void) requestMethod;
(void) requestUri;
return false;
}
virtual void upload(WebServerType& server, const String& requestUri, HTTPUpload& upload) {
(void) server;
(void) requestUri;
(void) upload;
}
RequestHandler<ServerType>* next() {
return _next;
}
void next(RequestHandler<ServerType>* r) {
_next = r;
}
virtual RequestHandler<ServerType>& setFilter(std::function<bool(ESP8266WebServerTemplate<ServerType>&)> filter) {
(void)filter;
return *this;
}
private:
RequestHandler<ServerType>* _next = nullptr;

54
libraries/ESP8266WebServer/src/detail/RequestHandlersImpl.h
View File

@@ -59,9 +59,22 @@ public:
return true;
}
bool canHandle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
if (_method != HTTP_ANY && _method != requestMethod)
return false;
return _uri->canHandle(requestUri, RequestHandler<ServerType>::pathArgs) && (_filter != NULL ? _filter(server) : true);
}
bool canUpload(WebServerType& server, const String& requestUri) override {
if (!_ufn || !canHandle(server, HTTP_POST, requestUri))
return false;
return true;
}
bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
(void) server;
if (!canHandle(requestMethod, requestUri))
if (!canHandle(server, requestMethod, requestUri))
return false;
_fn();
@@ -69,15 +82,22 @@ public:
}
void upload(WebServerType& server, const String& requestUri, HTTPUpload& upload) override {
(void) server;
(void) upload;
if (canUpload(requestUri))
if (canUpload(server, requestUri))
_ufn();
}
FunctionRequestHandler& setFilter(typename WebServerType::FilterFunction filter) {
_filter = filter;
return *this;
}
protected:
typename WebServerType::THandlerFunction _fn;
typename WebServerType::THandlerFunction _ufn;
// _filter should return 'true' when the request should be handled
// and 'false' when the request should be ignored
typename WebServerType::FilterFunction _filter;
Uri *_uri;
HTTPMethod _method;
};
@@ -115,7 +135,6 @@ protected:
// serve all files within a given directory
template<typename ServerType>
class StaticDirectoryRequestHandler : public StaticRequestHandler<ServerType> {
using SRH = StaticRequestHandler<ServerType>;
using WebServerType = ESP8266WebServerTemplate<ServerType>;
@@ -130,9 +149,12 @@ public:
return SRH::validMethod(requestMethod) && requestUri.startsWith(SRH::_uri);
}
bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
bool canHandle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
return SRH::validMethod(requestMethod) && requestUri.startsWith(SRH::_uri) && (_filter != NULL ? _filter(server) : true);
}
if (!canHandle(requestMethod, requestUri))
bool handle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
if (!canHandle(server, requestMethod, requestUri))
return false;
DEBUGV("DirectoryRequestHandler::handle: request=%s _uri=%s\r\n", requestUri.c_str(), SRH::_uri.c_str());
@@ -203,8 +225,14 @@ public:
return true;
}
StaticDirectoryRequestHandler& setFilter(typename WebServerType::FilterFunction filter) {
_filter = filter;
return *this;
}
protected:
size_t _baseUriLength;
typename WebServerType::FilterFunction _filter;
};
@@ -228,8 +256,12 @@ public:
return SRH::validMethod(requestMethod) && requestUri == SRH::_uri;
}
bool canHandle(WebServerType& server, HTTPMethod requestMethod, const String& requestUri) override {
return SRH::validMethod(requestMethod) && requestUri == SRH::_uri && (_filter != NULL ? _filter(server) : true);
}
bool handle(WebServerType& server, HTTPMethod requestMethod, const String & requestUri) override {
if (!canHandle(requestMethod, requestUri))
if (!canHandle(server, requestMethod, requestUri))
return false;
if (server._eTagEnabled) {
@@ -266,8 +298,14 @@ public:
return true;
}
StaticFileRequestHandler& setFilter(typename WebServerType::FilterFunction filter) {
_filter = filter;
return *this;
}
protected:
String _eTagCode; // ETag code calculated for this file as used in http header include quotes.
typename WebServerType::FilterFunction _filter;
};
} // namespace