Skip to content

WIP - Rewrite ESP8266WebServer using templates #4912

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

WIP - Rewrite ESP8266WebServer using templates #4912

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01a992f
Rewrite ESP8266WebServer using templates
earlephilhower Jul 9, 2018
bb3cd32
Update HTTPUpdateServer and examples to template
earlephilhower Jul 10, 2018
7df7b42
Clean up per @devyte's review comments
earlephilhower Apr 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
755 changes: 755 additions & 0 deletions libraries/ESP8266WebServer/src/ESP8266WebServer-impl.h
View file
Open in desktop

Large diffs are not rendered by default.

663 changes: 0 additions & 663 deletions libraries/ESP8266WebServer/src/ESP8266WebServer.cpp
View file
Open in desktop

This file was deleted.

57 changes: 34 additions & 23 deletions libraries/ESP8266WebServer/src/ESP8266WebServer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ enum HTTPAuthMethod { BASIC_AUTH, DIGEST_AUTH };
#define CONTENT_LENGTH_UNKNOWN ((size_t) -1)
#define CONTENT_LENGTH_NOT_SET ((size_t) -2)

class ESP8266WebServer;
template<class ServerClass, class ClientClass> class ESP8266WebServerTemplate;

typedef struct {
HTTPUploadStatus status;
Expand All @@ -66,18 +66,19 @@ namespace fs {
class FS;
}

class ESP8266WebServer
template<class ServerClass, class ClientClass>
class ESP8266WebServerTemplate
{
public:
ESP8266WebServer(IPAddress addr, int port = 80);
ESP8266WebServer(int port = 80);
virtual ~ESP8266WebServer();
ESP8266WebServerTemplate(IPAddress addr, int port = 80);
ESP8266WebServerTemplate(int port = 80);
~ESP8266WebServerTemplate();

virtual void begin();
virtual void begin(uint16_t port);
virtual void handleClient();
void begin();
void begin(uint16_t port);
void handleClient();

virtual void close();
void close();
void stop();

bool authenticate(const char * username, const char * password);
Expand All @@ -87,14 +88,14 @@ class ESP8266WebServer
void on(const String &uri, THandlerFunction handler);
void on(const String &uri, HTTPMethod method, THandlerFunction fn);
void on(const String &uri, HTTPMethod method, THandlerFunction fn, THandlerFunction ufn);
void addHandler(RequestHandler* handler);
void addHandler(RequestHandler<ServerClass, ClientClass>* handler);
void serveStatic(const char* uri, fs::FS& fs, const char* path, const char* cache_header = NULL );
void onNotFound(THandlerFunction fn); //called when handler is not assigned
void onFileUpload(THandlerFunction fn); //handle file uploads

String uri() { return _currentUri; }
HTTPMethod method() { return _currentMethod; }
virtual WiFiClient client() { return _currentClient; }
ClientClass client() { return _currentClient; }
HTTPUpload& upload() { return *_currentUpload; }

String arg(String name); // get request argument value by name
Expand Down Expand Up @@ -134,20 +135,26 @@ class ESP8266WebServer
_streamFileCore(file.size(), file.name(), contentType);
return _currentClient.write(file);
}


// AXTLS and BearSSL only
void setServerKeyAndCert(const uint8_t *key, int keyLen, const uint8_t *cert, int certLen) { }
void setServerKeyAndCert_P(const uint8_t *key, int keyLen, const uint8_t *cert, int certLen) { }
// BearSSL only
void setBufferSizes(int recv, int xmit) { };
void setRSACert(const BearSSLX509List *chain, const BearSSLPrivateKey *sk) { };
void setECCert(const BearSSLX509List *chain, unsigned cert_issuer_key_type, const BearSSLPrivateKey *sk) { };

protected:
virtual size_t _currentClientWrite(const char* b, size_t l) { return _currentClient.write( b, l ); }
virtual size_t _currentClientWrite_P(PGM_P b, size_t l) { return _currentClient.write_P( b, l ); }
void _addRequestHandler(RequestHandler* handler);
void _addRequestHandler(RequestHandler<ServerClass, ClientClass>* handler);
void _handleRequest();
void _finalizeResponse();
bool _parseRequest(WiFiClient& client);
bool _parseRequest(ClientClass& client);
void _parseArguments(String data);
static String _responseCodeToString(int code);
bool _parseForm(WiFiClient& client, String boundary, uint32_t len);
bool _parseForm(ClientClass& client, String boundary, uint32_t len);
bool _parseFormUploadAborted();
void _uploadWriteByte(uint8_t b);
uint8_t _uploadReadByte(WiFiClient& client);
uint8_t _uploadReadByte(ClientClass& client);
void _prepareHeader(String& response, int code, const char* content_type, size_t contentLength);
bool _collectHeader(const char* headerName, const char* headerValue);

Expand All @@ -162,18 +169,18 @@ class ESP8266WebServer
String value;
};

WiFiServer _server;
ServerClass _server;

WiFiClient _currentClient;
ClientClass _currentClient;
HTTPMethod _currentMethod;
String _currentUri;
uint8_t _currentVersion;
HTTPClientStatus _currentStatus;
unsigned long _statusChange;

RequestHandler* _currentHandler;
RequestHandler* _firstHandler;
RequestHandler* _lastHandler;
RequestHandler<ServerClass, ClientClass>* _currentHandler;
RequestHandler<ServerClass, ClientClass>* _firstHandler;
RequestHandler<ServerClass, ClientClass>* _lastHandler;
THandlerFunction _notFoundHandler;
THandlerFunction _fileUploadHandler;

Expand All @@ -195,5 +202,9 @@ class ESP8266WebServer

};

#include "ESP8266WebServer-impl.h"
#include "Parsing-impl.h"

typedef ESP8266WebServerTemplate<WiFiServer, WiFiClient> ESP8266WebServer;

#endif //ESP8266WEBSERVER_H
12 changes: 10 additions & 2 deletions libraries/ESP8266WebServer/src/ESP8266WebServerSecure.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,13 @@
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/

#include "ESP8266WebServerSecureAxTLS.h"
#include "ESP8266WebServerSecureBearSSL.h"
#include "ESP8266WebServer.h"

namespace axTLS {
typedef ESP8266WebServerTemplate<WiFiServerSecure, WiFiClientSecure> ESP8266WebServerSecure;
};

namespace BearSSL {
typedef ESP8266WebServerTemplate<WiFiServerSecure, WiFiClientSecure> ESP8266WebServerSecure;
};

149 changes: 0 additions & 149 deletions libraries/ESP8266WebServer/src/ESP8266WebServerSecureAxTLS.cpp
View file
Open in desktop

This file was deleted.

64 changes: 0 additions & 64 deletions libraries/ESP8266WebServer/src/ESP8266WebServerSecureAxTLS.h
View file
Open in desktop

This file was deleted.

Loading