Update HTTPUpdateServer and examples to template

earlephilhower · earlephilhower · commit bb3cd32da48a · 2018-07-09T19:35:58.000-07:00
diff --git a/libraries/ESP8266HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino b/libraries/ESP8266HTTPUpdateServer/examples/SecureBearSSLUpdater/SecureBearSSLUpdater.ino
@@ -27,7 +27,7 @@ const char* ssid = "........";
 const char* password = "........";
 
 BearSSL::ESP8266WebServerSecure httpServer(443);
-ESP8266HTTPUpdateServer httpUpdater;
+ESP8266HTTPUpdateServerTemplate<BearSSL::WiFiServerSecure, BearSSL::WiFiClientSecure> httpUpdater;
 
 static const char serverCert[] PROGMEM = R"EOF(
 -----BEGIN CERTIFICATE-----
diff --git a/libraries/ESP8266HTTPUpdateServer/examples/SecureHTTPSUpdater/SecureHTTPSUpdater.ino b/libraries/ESP8266HTTPUpdateServer/examples/SecureHTTPSUpdater/SecureHTTPSUpdater.ino
@@ -56,7 +56,7 @@ const char* ssid = "........";
 const char* password = "........";
 
 ESP8266WebServerSecure httpServer(443);
-ESP8266HTTPUpdateServer httpUpdater;
+ESP8266HTTPUpdateServerTemplate<axTLS::WiFiServerSecure, axTLS::WiFiClientSecure> httpUpdater;
 
 // The certificate is stored in PMEM
 static const uint8_t x509[] PROGMEM = {
diff --git a/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer-impl.h b/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer-impl.h
@@ -6,17 +6,17 @@
 #include "StreamString.h"
 #include "ESP8266HTTPUpdateServer.h"
 
-
-static const char serverIndex[] PROGMEM =
+static const char serverIndex[] =
   R"(<html><body><form method='POST' action='' enctype='multipart/form-data'>
                   <input type='file' name='update'>
                   <input type='submit' value='Update'>
                </form>
          </body></html>)";
-static const char successResponse[] PROGMEM = 
+static const char successResponse[] = 
   "<META http-equiv=\"refresh\" content=\"15;URL=/\">Update Success! Rebooting...\n";
 
-ESP8266HTTPUpdateServer::ESP8266HTTPUpdateServer(bool serial_debug)
+template <class ServerClass, class ClientClass>
+ESP8266HTTPUpdateServerTemplate<ServerClass, ClientClass>::ESP8266HTTPUpdateServerTemplate(bool serial_debug)
 {
   _serial_output = serial_debug;
   _server = NULL;
@@ -25,7 +25,8 @@ ESP8266HTTPUpdateServer::ESP8266HTTPUpdateServer(bool serial_debug)
   _authenticated = false;
 }
 
-void ESP8266HTTPUpdateServer::setup(ESP8266WebServer *server, const char * path, const char * username, const char * password)
+template <class ServerClass, class ClientClass>
+void ESP8266HTTPUpdateServerTemplate<ServerClass, ClientClass>::setup(ESP8266WebServerTemplate<ServerClass, ClientClass> *server, const char * path, const char * username, const char * password)
 {
     _server = server;
     _username = (char *)username;
@@ -35,18 +36,18 @@ void ESP8266HTTPUpdateServer::setup(ESP8266WebServer *server, const char * path,
     _server->on(path, HTTP_GET, [&](){
       if(_username != NULL && _password != NULL && !_server->authenticate(_username, _password))
         return _server->requestAuthentication();
-      _server->send_P(200, PSTR("text/html"), serverIndex);
+      _server->send_P(200, ("text/html"), serverIndex);
     });
 
     // handler for the /update form POST (once file upload finishes)
     _server->on(path, HTTP_POST, [&](){
       if(!_authenticated)
         return _server->requestAuthentication();
       if (Update.hasError()) {
-        _server->send(200, F("text/html"), String(F("Update error: ")) + _updaterError);
+        _server->send(200, ("text/html"), String(("Update error: ")) + _updaterError);
       } else {
         _server->client().setNoDelay(true);
-        _server->send_P(200, PSTR("text/html"), successResponse);
+        _server->send_P(200, ("text/html"), successResponse);
         delay(100);
         _server->client().stop();
         ESP.restart();
@@ -95,7 +96,8 @@ void ESP8266HTTPUpdateServer::setup(ESP8266WebServer *server, const char * path,
     });
 }
 
-void ESP8266HTTPUpdateServer::_setUpdaterError()
+template <class ServerClass, class ClientClass>
+void ESP8266HTTPUpdateServerTemplate<ServerClass, ClientClass>::_setUpdaterError()
 {
   if (_serial_output) Update.printError(Serial);
   StreamString str;
diff --git a/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer.h b/libraries/ESP8266HTTPUpdateServer/src/ESP8266HTTPUpdateServer.h
@@ -1,29 +1,30 @@
 #ifndef __HTTP_UPDATE_SERVER_H
 #define __HTTP_UPDATE_SERVER_H
 
-class ESP8266WebServer;
+#include <ESP8266WebServer.h>
 
-class ESP8266HTTPUpdateServer
+template<class ServerClass, class ClientClass>
+class ESP8266HTTPUpdateServerTemplate
 {
   public:
-    ESP8266HTTPUpdateServer(bool serial_debug=false);
+    ESP8266HTTPUpdateServerTemplate(bool serial_debug=false);
 
-    void setup(ESP8266WebServer *server)
+    void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> *server)
     {
       setup(server, NULL, NULL);
     }
 
-    void setup(ESP8266WebServer *server, const char * path)
+    void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> *server, const char * path)
     {
       setup(server, path, NULL, NULL);
     }
 
-    void setup(ESP8266WebServer *server, const char * username, const char * password)
+    void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> *server, const char * username, const char * password)
     {
       setup(server, "/update", username, password);
     }
 
-    void setup(ESP8266WebServer *server, const char * path, const char * username, const char * password);
+    void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> *server, const char * path, const char * username, const char * password);
 
     void updateCredentials(const char * username, const char * password)
     {
@@ -36,12 +37,15 @@ class ESP8266HTTPUpdateServer
 
   private:
     bool _serial_output;
-    ESP8266WebServer *_server;
+    ESP8266WebServerTemplate<ServerClass, ClientClass> *_server;
     char * _username;
     char * _password;
     bool _authenticated;
     String _updaterError;
 };
 
+#include "ESP8266HTTPUpdateServer-impl.h"
+
+typedef ESP8266HTTPUpdateServerTemplate<WiFiServer, WiFiClient> ESP8266HTTPUpdateServer;
 
 #endif
diff --git a/libraries/ESP8266WebServer/src/ESP8266WebServer-impl.h b/libraries/ESP8266WebServer/src/ESP8266WebServer-impl.h
@@ -515,7 +515,7 @@ void ESP8266WebServerTemplate<ServerClass, ClientClass>::_streamFileCore(const s
   if (fileName.endsWith(String(FPSTR(mimeTable[gz].endsWith))) &&
       contentType != String(FPSTR(mimeTable[gz].mimeType)) &&
       contentType != String(FPSTR(mimeTable[none].mimeType))) {
-    sendHeader(F("Content-Encoding"), F("gzip"));
+    sendHeader(("Content-Encoding"), ("gzip"));
   }
   send(200, contentType, "");
 }
diff --git a/libraries/ESP8266WebServer/src/ESP8266WebServerSecure.h b/libraries/ESP8266WebServer/src/ESP8266WebServerSecure.h
@@ -21,6 +21,9 @@
 
 #include "ESP8266WebServer.h"
 
+#ifndef ESP8266SECUREWEBSERVER_H
+#define ESP8266SECUREWEBSERVER_H
+
 namespace axTLS {
   typedef ESP8266WebServerTemplate<WiFiServerSecure, WiFiClientSecure> ESP8266WebServerSecure;
 };
@@ -29,3 +32,4 @@ namespace BearSSL {
   typedef ESP8266WebServerTemplate<WiFiServerSecure, WiFiClientSecure> ESP8266WebServerSecure;
 };
 
+#endif

Original file line number	Diff line number	Diff line change
`@@ -1,29 +1,30 @@`
`1`	`1`	`#ifndef __HTTP_UPDATE_SERVER_H`
`2`	`2`	`#define __HTTP_UPDATE_SERVER_H`
`3`	`3`
`4`		`-class ESP8266WebServer;`
	`4`	`+#include <ESP8266WebServer.h>`
`5`	`5`
`6`		`-class ESP8266HTTPUpdateServer`
	`6`	`+template<class ServerClass, class ClientClass>`
	`7`	`+class ESP8266HTTPUpdateServerTemplate`
`7`	`8`	`{`
`8`	`9`	`public:`
`9`		`- ESP8266HTTPUpdateServer(bool serial_debug=false);`
	`10`	`+ ESP8266HTTPUpdateServerTemplate(bool serial_debug=false);`
`10`	`11`
`11`		`- void setup(ESP8266WebServer *server)`
	`12`	`+ void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> *server)`
`12`	`13`	`{`
`13`	`14`	`setup(server, NULL, NULL);`
`14`	`15`	`}`
`15`	`16`
`16`		`- void setup(ESP8266WebServer server, const char path)`
	`17`	`+ void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> server, const char path)`
`17`	`18`	`{`
`18`	`19`	`setup(server, path, NULL, NULL);`
`19`	`20`	`}`
`20`	`21`
`21`		`- void setup(ESP8266WebServer server, const char username, const char * password)`
	`22`	`+ void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> server, const char username, const char * password)`
`22`	`23`	`{`
`23`	`24`	`setup(server, "/update", username, password);`
`24`	`25`	`}`
`25`	`26`
`26`		`- void setup(ESP8266WebServer server, const char path, const char * username, const char * password);`
	`27`	`+ void setup(ESP8266WebServerTemplate<ServerClass, ClientClass> server, const char path, const char * username, const char * password);`
`27`	`28`
`28`	`29`	`void updateCredentials(const char * username, const char * password)`
`29`	`30`	`{`
`@@ -36,12 +37,15 @@ class ESP8266HTTPUpdateServer`
`36`	`37`
`37`	`38`	`private:`
`38`	`39`	`bool _serial_output;`
`39`		`- ESP8266WebServer *_server;`
	`40`	`+ ESP8266WebServerTemplate<ServerClass, ClientClass> *_server;`
`40`	`41`	`char * _username;`
`41`	`42`	`char * _password;`
`42`	`43`	`bool _authenticated;`
`43`	`44`	`String _updaterError;`
`44`	`45`	`};`
`45`	`46`
	`47`	`+#include "ESP8266HTTPUpdateServer-impl.h"`
	`48`	`+`
	`49`	`+typedef ESP8266HTTPUpdateServerTemplate<WiFiServer, WiFiClient> ESP8266HTTPUpdateServer;`
`46`	`50`
`47`	`51`	`#endif`
Original file line number	Diff line number	Diff line change
`@@ -515,7 +515,7 @@ void ESP8266WebServerTemplate<ServerClass, ClientClass>::_streamFileCore(const s`
`515`	`515`	`if (fileName.endsWith(String(FPSTR(mimeTable[gz].endsWith))) &&`
`516`	`516`	`contentType != String(FPSTR(mimeTable[gz].mimeType)) &&`
`517`	`517`	`contentType != String(FPSTR(mimeTable[none].mimeType))) {`
`518`		`- sendHeader(F("Content-Encoding"), F("gzip"));`
	`518`	`+ sendHeader(("Content-Encoding"), ("gzip"));`
`519`	`519`	`}`
`520`	`520`	`send(200, contentType, "");`
`521`	`521`	`}`