Convert ESP8266WebServer* into templatized model (#5982)

* Convert ESP8266WebServer* into templatized model

Supercedes #4912

Refactor the three versions of ESP8266WebServer and *WebServerSecure to a
single templated class. Use "using" to enable old, non-templated names to b
used (so no user changes required to compile or run).

Fixes #4908 and clean up the code base a lot.

Basic tests run (the ones in the example code).

No code changes are required in userland except for setting the SSL
certificates which now use a cleaner "getServer()" accessor and lets the
app use the native BearSSL calls on the WiFiClientSecure object.

@devyte should be proud, it removes virtuals and even has template specialization...

* Fix HTTPUpdate templates and examples

* Fix HTTPUpdateServer library build

Need to remove dot-a linkage since there are no .cpp files in the
directory anymore due to templates.

* Provide backward-compat names for updt template

Allow existing code to use the same well known names for
HTTPUpdateSecure.

* Remove ClientType from all templates, auto-infer

Remove the ClientType template parameter from all objects.  Simplifies
the code and makes it more foolproof.

Add a "using" in each server to define the type of connection returned
by all servers, which is then used in the above templates automatically.

* Can safely include FS.h now that SD/SPIFFS unified

* Move the templates/objects to their own namespaces

* Fix merge issues with untemplated methods

* Address review comments

* Fix mock test, remove warnings inside test dir

Make the simple mock test CI job pass and clean up
any spurious warnings in the test directory.

There still are warnings in the libraries and core, but they
should be addressed in a separate PR.

Author: earlephilhower

libraries/ESP8266HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino

@@ -31,8 +31,8 @@ const char* update_password = "admin";
 const char* ssid = STASSID;
 const char* password = STAPSK;
 
-BearSSL::ESP8266WebServerSecure httpServer(443);
-ESP8266HTTPUpdateServer httpUpdater;
+ESP8266WebServerSecure httpServer(443);
+ESP8266HTTPUpdateServerSecure httpUpdater;
 
 static const char serverCert[] PROGMEM = R"EOF(
 -----BEGIN CERTIFICATE-----
@@ -106,7 +106,7 @@ void setup()
 
   MDNS.begin(host);
 
-  httpServer.setRSACert(new BearSSL::X509List(serverCert), new BearSSL::PrivateKey(serverKey));
+  httpServer.getServer().setRSACert(new BearSSL::X509List(serverCert), new BearSSL::PrivateKey(serverKey));
   httpUpdater.setup(&httpServer, update_path, update_username, update_password);
   httpServer.begin();
 

libraries/ESP8266HTTPUpdateServer/examples/SecureHTTPSUpdater/SecureHTTPSUpdater.ino

@@ -42,11 +42,21 @@
   This example is released into the public domain.
 */
 
+// AXTLS is deprecated, do not use in new code.
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+
 #include <ESP8266WiFi.h>
 #include <WiFiClient.h>
 #include <ESP8266WebServerSecure.h>
 #include <ESP8266mDNS.h>
 #include <ESP8266HTTPUpdateServer.h>
+#include <WiFiServerSecure.h>
+#include <WiFiServerSecureAxTLS.h>
+#include <WiFiClientSecure.h>
+#include <WiFiClientSecureAxTLS.h>
+
+#pragma GCC diagnostic pop
 
 #ifndef STASSID
 #define STASSID "your-ssid"
@@ -60,8 +70,8 @@ const char* update_password = "admin";
 const char* ssid = STASSID;
 const char* password = STAPSK;
 
-ESP8266WebServerSecure httpServer(443);
-ESP8266HTTPUpdateServer httpUpdater;
+axTLS::ESP8266WebServerSecure httpServer(443);
+axTLS::ESP8266HTTPUpdateServerSecure httpUpdater;
 
 // The certificate is stored in PMEM
 static const uint8_t x509[] PROGMEM = {
@@ -176,7 +186,7 @@ void setup() {
 
   MDNS.begin(host);
 
-  httpServer.setServerKeyAndCert_P(rsakey, sizeof(rsakey), x509, sizeof(x509));
+  httpServer.getServer().setServerKeyAndCert_P(rsakey, sizeof(rsakey), x509, sizeof(x509));
   httpUpdater.setup(&httpServer, update_path, update_username, update_password);
   httpServer.begin();
 

libraries/ESP8266HTTPUpdateServer/library.properties

@@ -7,4 +7,4 @@ paragraph=The library accepts HTTP post requests to the /update url, and updates
 category=Communication
 url=
 architectures=esp8266
-dot_a_linkage=true
+dot_a_linkage=false

libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer.cpp renamed to libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer-impl.h

@@ -6,6 +6,8 @@
 #include "StreamString.h"
 #include "ESP8266HTTPUpdateServer.h"
 
+namespace esp8266httpupdateserver {
+using namespace esp8266webserver;
 
 static const char serverIndex[] PROGMEM =
   R"(<html><body><form method='POST' action='' enctype='multipart/form-data'>
@@ -16,7 +18,8 @@ static const char serverIndex[] PROGMEM =
 static const char successResponse[] PROGMEM = 
   "<META http-equiv=\"refresh\" content=\"15;URL=/\">Update Success! Rebooting...\n";
 
-ESP8266HTTPUpdateServer::ESP8266HTTPUpdateServer(bool serial_debug)
+template <typename ServerType>
+ESP8266HTTPUpdateServerTemplate<ServerType>::ESP8266HTTPUpdateServerTemplate(bool serial_debug)
 {
   _serial_output = serial_debug;
   _server = NULL;
@@ -25,7 +28,8 @@ ESP8266HTTPUpdateServer::ESP8266HTTPUpdateServer(bool serial_debug)
   _authenticated = false;
 }
 
-void ESP8266HTTPUpdateServer::setup(ESP8266WebServer *server, const String& path, const String& username, const String& password)
+template <typename ServerType>
+void ESP8266HTTPUpdateServerTemplate<ServerType>::setup(ESP8266WebServerTemplate<ServerType> *server, const String& path, const String& username, const String& password)
 {
     _server = server;
     _username = username;
@@ -95,10 +99,13 @@ void ESP8266HTTPUpdateServer::setup(ESP8266WebServer *server, const String& path
     });
 }
 
-void ESP8266HTTPUpdateServer::_setUpdaterError()
+template <typename ServerType>
+void ESP8266HTTPUpdateServerTemplate<ServerType>::_setUpdaterError()
 {
   if (_serial_output) Update.printError(Serial);
   StreamString str;
   Update.printError(str);
   _updaterError = str.c_str();
 }
+
+};

libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer.h

@@ -1,29 +1,33 @@
 #ifndef __HTTP_UPDATE_SERVER_H
 #define __HTTP_UPDATE_SERVER_H
 
-class ESP8266WebServer;
+#include <ESP8266WebServer.h>
 
-class ESP8266HTTPUpdateServer
+namespace esp8266httpupdateserver {
+using namespace esp8266webserver;
+
+template <typename ServerType>
+class ESP8266HTTPUpdateServerTemplate
 {
   public:
-    ESP8266HTTPUpdateServer(bool serial_debug=false);
+    ESP8266HTTPUpdateServerTemplate(bool serial_debug=false);
 
-    void setup(ESP8266WebServer *server)
+    void setup(ESP8266WebServerTemplate<ServerType> *server)
     {
       setup(server, emptyString, emptyString);
     }
 
-    void setup(ESP8266WebServer *server, const String& path)
+    void setup(ESP8266WebServerTemplate<ServerType> *server, const String& path)
     {
       setup(server, path, emptyString, emptyString);
     }
 
-    void setup(ESP8266WebServer *server, const String& username, const String& password)
+    void setup(ESP8266WebServerTemplate<ServerType> *server, const String& username, const String& password)
     {
       setup(server, "/update", username, password);
     }
 
-    void setup(ESP8266WebServer *server, const String& path, const String& username, const String& password);
+    void setup(ESP8266WebServerTemplate<ServerType> *server, const String& path, const String& username, const String& password);
 
     void updateCredentials(const String& username, const String& password)
     {
@@ -36,12 +40,26 @@ class ESP8266HTTPUpdateServer
 
   private:
     bool _serial_output;
-    ESP8266WebServer *_server;
+    ESP8266WebServerTemplate<ServerType> *_server;
     String _username;
     String _password;
     bool _authenticated;
     String _updaterError;
 };
 
+};
+
+#include "ESP8266HTTPUpdateServer-impl.h"
+
+
+using ESP8266HTTPUpdateServer = esp8266httpupdateserver::ESP8266HTTPUpdateServerTemplate<WiFiServer>;
+
+namespace BearSSL {
+using ESP8266HTTPUpdateServerSecure = esp8266httpupdateserver::ESP8266HTTPUpdateServerTemplate<WiFiServerSecure>;
+};
+
+namespace axTLS {
+using ESP8266HTTPUpdateServerSecure = esp8266httpupdateserver::ESP8266HTTPUpdateServerTemplate<WiFiServerSecure>;
+};
 
 #endif

libraries/ESP8266WebServer/examples/HelloServerBearSSL/HelloServerBearSSL.ino

@@ -128,7 +128,7 @@ void setup(void){
     Serial.println("MDNS responder started");
   }
 
-  server.setRSACert(new BearSSL::X509List(serverCert), new BearSSL::PrivateKey(serverKey));
+  server.getServer().setRSACert(new BearSSL::X509List(serverCert), new BearSSL::PrivateKey(serverKey));
 
   server.on("/", handleRoot);
 

libraries/ESP8266WebServer/examples/HelloServerSecure/HelloServerSecure.ino

@@ -165,7 +165,7 @@ void setup(void) {
     Serial.println("MDNS responder started");
   }
 
-  server.setServerKeyAndCert_P(rsakey, sizeof(rsakey), x509, sizeof(x509));
+  server.getServer().setServerKeyAndCert_P(rsakey, sizeof(rsakey), x509, sizeof(x509));
 
   server.on("/", handleRoot);
 

libraries/ESP8266WebServer/examples/HttpHashCredAuth/HttpHashCredAuth.ino

@@ -110,7 +110,7 @@ void setup() {
     ESP.restart();
   }
 
-  server.setRSACert(new BearSSL::X509List(serverCert), new BearSSL::PrivateKey(serverKey));
+  server.getServer().setRSACert(new BearSSL::X509List(serverCert), new BearSSL::PrivateKey(serverKey));
   server.on("/",showcredentialpage); //for this simple example, just show a simple page for changing credentials at the root
   server.on("/" + change_creds,handlecredentialchange); //handles submission of credentials from the client
   server.onNotFound(redirect);