* feat: new portal & network manager

* refactor: migrate from PubSubClient to ArduinoMqttClient
* refactor: migrate from EEManager to FileData
* chore: bump ESP Telnet to 2.2
* chore: bump TinyLogger to 1.1.0

lib/WebServerHandlers/DynamicPage.h

@@ -0,0 +1,227 @@
+#include <FS.h>
+
+
+class DynamicPage : public RequestHandler {
+public:
+  typedef std::function<bool(HTTPMethod, const String&)> canHandleFunction;
+  typedef std::function<bool()> beforeSendFunction;
+  typedef std::function<String(const char*)> templateFunction;
+  
+  DynamicPage(const char* uri, FS* fs, const char* path, const char* cacheHeader = nullptr) {
+    this->uri = uri;
+    this->fs = fs;
+    this->path = path;
+    this->cacheHeader = cacheHeader;
+  }
+
+  DynamicPage* setCanHandleFunction(canHandleFunction val = nullptr) {
+    this->canHandleFn = val;
+
+    return this;
+  }
+
+  DynamicPage* setBeforeSendFunction(beforeSendFunction val = nullptr) {
+    this->beforeSendFn = val;
+
+    return this;
+  }
+
+  DynamicPage* setTemplateFunction(templateFunction val = nullptr) {
+    this->templateFn = val;
+
+    return this;
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  bool canHandle(HTTPMethod method, const String uri) override {
+  #else
+  bool canHandle(HTTPMethod method, const String& uri) override {
+  #endif
+    return uri.equals(this->uri) && (!this->canHandleFn || this->canHandleFn(method, uri));
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  bool handle(WebServer& server, HTTPMethod method, const String uri) override {
+  #else
+  bool handle(WebServer& server, HTTPMethod method, const String& uri) override {
+  #endif
+    if (!this->canHandle(method, uri)) {
+      return false;
+    }
+
+    if (this->beforeSendFn && !this->beforeSendFn()) {
+      return true;
+    }
+
+    File file = this->fs->open(this->path, "r");
+    if (!file) {
+      return false;
+
+    } else if (file.isDirectory()) {
+      file.close();
+      return false;
+    }
+
+    if (this->cacheHeader != nullptr) {
+      server.sendHeader("Cache-Control", this->cacheHeader);
+    }
+
+    #ifdef ARDUINO_ARCH_ESP8266
+    if (!server.chunkedResponseModeStart(200, F("text/html"))) {
+      server.send(505, F("text/html"), F("HTTP1.1 required"));
+      return true;
+    }
+    #else
+    server.send(200, F("text/html"), "");
+    #endif
+
+    uint8_t* argStartPos = nullptr;
+    uint8_t* argEndPos = nullptr;
+    uint8_t argName[16];
+    size_t sizeArgName = 0;
+    bool argNameProcess = false;
+    while (file.available()) {
+      uint8_t buf[64];
+      size_t length = file.read(buf, sizeof(buf));
+      size_t offset = 0;
+
+      if (argNameProcess) {
+        argEndPos = (uint8_t*) memchr(buf, '}', length);
+        
+        if (argEndPos != nullptr) {
+          size_t fullSizeArgName = sizeArgName + (argEndPos - buf);
+          if (fullSizeArgName < sizeof(argName)) {
+            // copy full arg name
+            if (argEndPos - buf > 0) {
+              memcpy(argName + sizeArgName, buf, argEndPos - buf);
+            }
+            argName[fullSizeArgName] = '\0';
+
+            // send arg value
+            String argValue = this->templateFn((const char*) argName);
+            if (argValue.length()) {
+              server.sendContent(argValue.c_str());
+
+            } else if (fullSizeArgName > 0) {
+              server.sendContent("{");
+              server.sendContent((const char*) argName);
+              server.sendContent("}");
+            }
+
+            offset = size_t(argEndPos - buf + 1);
+            sizeArgName = 0;
+            argNameProcess = false;
+          }
+        }
+
+        if (argNameProcess) {
+          server.sendContent("{");
+
+          if (sizeArgName > 0) {
+            argName[sizeArgName] = '\0';
+            server.sendContent((const char*) argName);
+          }
+
+          argNameProcess = false;
+        }
+      }
+
+      do {
+        uint8_t* currentBuf = buf + offset;
+        size_t currentLength = length - offset;
+
+        argStartPos = (uint8_t*) memchr(currentBuf, '{', currentLength);
+
+        // send all content
+        if (argStartPos == nullptr) {
+          if (currentLength > 0) {
+            server.sendContent((const char*) currentBuf, currentLength);
+          }
+
+          break;
+        }
+        
+        argEndPos = (uint8_t*) memchr(argStartPos, '}', length - (argStartPos - buf));
+        if (argEndPos != nullptr) {
+          sizeArgName = argEndPos - argStartPos - 1;
+
+          // send all content if arg len > space
+          if (sizeArgName >= sizeof(argName)) {
+            if (currentLength > 0) {
+              server.sendContent((const char*) currentBuf, currentLength);
+            }
+
+            break;
+          }
+          
+          // arg name
+          memcpy(argName, argStartPos + 1, sizeArgName);
+          argName[sizeArgName] = '\0';
+
+          // send arg value
+          String argValue = this->templateFn((const char*) argName);
+          if (argValue.length()) {
+            // send content before var
+            if (argStartPos - buf > 0) {
+              server.sendContent((const char*) currentBuf, argStartPos - buf);
+            }
+
+            server.sendContent(argValue.c_str());
+            
+          } else {
+            server.sendContent((const char*) currentBuf, argEndPos - currentBuf + 1);
+          }
+
+          offset = size_t(argEndPos - currentBuf + 1);
+
+        } else {
+          sizeArgName = length - size_t(argStartPos - currentBuf) - 1;
+          Serial.printf("sizeArgName: %d\r\n", sizeArgName);
+
+          // send all content if arg len > space
+          if (sizeArgName >= sizeof(argName)) {
+            if (currentLength) {
+              server.sendContent((const char*) currentBuf, currentLength);
+            }
+
+            break;
+          }
+
+          // send content before var
+          if (argStartPos - buf > 0) {
+            server.sendContent((const char*) currentBuf, argStartPos - buf);
+          }
+
+          // copy arg name chunk
+          if (sizeArgName > 0) {
+            memcpy(argName, argStartPos + 1, sizeArgName);
+          }
+
+          argNameProcess = true;
+
+          break;
+        }
+      } while(true);
+    }
+    
+    file.close();
+
+    #ifdef ARDUINO_ARCH_ESP8266
+    server.chunkedResponseFinalize();
+    #else
+    server.sendContent("");
+    #endif
+
+    return true;
+  }
+
+protected:
+  FS* fs = nullptr;
+  canHandleFunction canHandleFn;
+  beforeSendFunction beforeSendFn;
+  templateFunction templateFn;
+  String eTag;
+  const char* uri = nullptr;
+  const char* path = nullptr;
+  const char* cacheHeader = nullptr;
+};

lib/WebServerHandlers/StaticPage.h

@@ -0,0 +1,96 @@
+#include <FS.h>
+
+class StaticPage : public RequestHandler {
+public:
+  typedef std::function<bool(HTTPMethod, const String&)> canHandleFunction;
+  typedef std::function<bool()> beforeSendFunction;
+  
+  StaticPage(const char* uri, FS* fs, const char* path, const char* cacheHeader = nullptr) {
+    this->uri = uri;
+    this->fs = fs;
+    this->path = path;
+    this->cacheHeader = cacheHeader;
+  }
+
+  StaticPage* setCanHandleFunction(canHandleFunction val = nullptr) {
+    this->canHandleFn = val;
+
+    return this;
+  }
+
+  StaticPage* setBeforeSendFunction(beforeSendFunction val = nullptr) {
+    this->beforeSendFn = val;
+
+    return this;
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  bool canHandle(HTTPMethod method, const String uri) override {
+  #else
+  bool canHandle(HTTPMethod method, const String& uri) override {
+  #endif
+    return method == HTTP_GET && uri.equals(this->uri) && (!this->canHandleFn || this->canHandleFn(method, uri));
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  bool handle(WebServer& server, HTTPMethod method, const String uri) override {
+  #else
+  bool handle(WebServer& server, HTTPMethod method, const String& uri) override {
+  #endif
+    if (!this->canHandle(method, uri)) {
+      return false;
+    }
+
+    if (this->beforeSendFn && !this->beforeSendFn()) {
+      return true;
+    }
+
+    #if defined(ARDUINO_ARCH_ESP8266)
+    if (server._eTagEnabled) {
+      if (server._eTagFunction) {
+        this->eTag = (server._eTagFunction)(*this->fs, this->path);
+
+      } else  if (this->eTag.isEmpty()) {
+        this->eTag = esp8266webserver::calcETag(*this->fs, this->path);
+      }
+
+      if (server.header("If-None-Match").equals(this->eTag.c_str())) {
+        server.send(304);
+        return true;
+      }
+    }
+    #endif
+
+    File file = this->fs->open(this->path, "r");
+    if (!file) {
+      return false;
+
+    } else if (file.isDirectory()) {
+      file.close();
+      return false;
+    }
+
+    if (this->cacheHeader != nullptr) {
+      server.sendHeader("Cache-Control", this->cacheHeader);
+    }
+
+    #if defined(ARDUINO_ARCH_ESP8266)
+    if (server._eTagEnabled && this->eTag.length() > 0) {
+      server.sendHeader("ETag", this->eTag);
+    }
+    #endif
+
+    server.streamFile(file, F("text/html"), method);
+
+    return true;
+  }
+
+protected:
+  FS* fs = nullptr;
+  canHandleFunction canHandleFn;
+  beforeSendFunction beforeSendFn;
+  String eTag;
+  const char* uri = nullptr;
+  const char* path = nullptr;
+  const char* cacheHeader = nullptr;
+};

lib/WebServerHandlers/UpgradeHandler.h

@@ -0,0 +1,218 @@
+#include <Arduino.h>
+
+class UpgradeHandler : public RequestHandler {
+public:
+  enum class UpgradeType {
+    FIRMWARE = 0,
+    FILESYSTEM = 1
+  };
+
+  enum class UpgradeStatus {
+    NONE,
+    NO_FILE,
+    SUCCESS,
+    PROHIBITED,
+    ABORTED,
+    ERROR_ON_START,
+    ERROR_ON_WRITE,
+    ERROR_ON_FINISH
+  };
+
+  typedef struct {
+    UpgradeType type;
+    UpgradeStatus status;
+    String error;
+  } UpgradeResult;
+
+  typedef std::function<bool(HTTPMethod, const String&)> CanHandleFunction;
+  typedef std::function<bool(const String&)> CanUploadFunction;
+  typedef std::function<bool(UpgradeType)> BeforeUpgradeFunction;
+  typedef std::function<void(const UpgradeResult&, const UpgradeResult&)> AfterUpgradeFunction;
+  
+  UpgradeHandler(const char* uri) {
+    this->uri = uri;
+  }
+
+  UpgradeHandler* setCanHandleFunction(CanHandleFunction val = nullptr) {
+    this->canHandleFn = val;
+
+    return this;
+  }
+
+  UpgradeHandler* setCanUploadFunction(CanUploadFunction val = nullptr) {
+    this->canUploadFn = val;
+
+    return this;
+  }
+
+  UpgradeHandler* setBeforeUpgradeFunction(BeforeUpgradeFunction val = nullptr) {
+    this->beforeUpgradeFn = val;
+
+    return this;
+  }
+
+  UpgradeHandler* setAfterUpgradeFunction(AfterUpgradeFunction val = nullptr) {
+    this->afterUpgradeFn = val;
+
+    return this;
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  bool canHandle(HTTPMethod method, const String uri) override {
+  #else
+  bool canHandle(HTTPMethod method, const String& uri) override {
+  #endif
+    return method == HTTP_POST && uri.equals(this->uri) && (!this->canHandleFn || this->canHandleFn(method, uri));
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  bool canUpload(const String uri) override {
+  #else
+  bool canUpload(const String& uri) override {
+  #endif
+    return uri.equals(this->uri) && (!this->canUploadFn || this->canUploadFn(uri));
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  bool handle(WebServer& server, HTTPMethod method, const String uri) override {
+  #else
+  bool handle(WebServer& server, HTTPMethod method, const String& uri) override {
+  #endif
+    if (this->afterUpgradeFn) {
+      this->afterUpgradeFn(this->firmwareResult, this->filesystemResult);
+    }
+
+    this->firmwareResult.status = UpgradeStatus::NONE;
+    this->firmwareResult.error.clear();
+
+    this->filesystemResult.status = UpgradeStatus::NONE;
+    this->filesystemResult.error.clear();
+
+    return true;
+  }
+
+  #if defined(ARDUINO_ARCH_ESP32)
+  void upload(WebServer& server, const String uri, HTTPUpload& upload) override {
+  #else
+  void upload(WebServer& server, const String& uri, HTTPUpload& upload) override {
+  #endif
+    UpgradeResult* result;
+    if (upload.name.equals("firmware")) {
+      result = &this->firmwareResult;
+    } else if (upload.name.equals("filesystem")) {
+      result = &this->filesystemResult;
+    } else {
+      return;
+    }
+
+    if (result->status != UpgradeStatus::NONE) {
+      return;
+    }
+
+    if (this->beforeUpgradeFn && !this->beforeUpgradeFn(result->type)) {
+      result->status = UpgradeStatus::PROHIBITED;
+      return;
+    }
+
+    if (!upload.filename.length()) {
+      result->status = UpgradeStatus::NO_FILE;
+      return;
+    }
+
+    if (upload.status == UPLOAD_FILE_START) {
+      // reset
+      if (Update.isRunning()) {
+        Update.end(false);
+        Update.clearError();
+      }
+
+      bool begin = false;
+      #ifdef ARDUINO_ARCH_ESP8266
+      Update.runAsync(true);
+      
+      if (result->type == UpgradeType::FIRMWARE) {
+        begin = Update.begin((ESP.getFreeSketchSpace() - 0x1000) & 0xFFFFF000, U_FLASH);
+        
+      } else if (result->type == UpgradeType::FILESYSTEM) {
+        close_all_fs();
+        begin = Update.begin((size_t)FS_end - (size_t)FS_start, U_FS);
+      }
+      #elif defined(ARDUINO_ARCH_ESP32)
+      if (result->type == UpgradeType::FIRMWARE) {
+        begin = Update.begin(UPDATE_SIZE_UNKNOWN, U_FLASH);
+        
+      } else if (result->type == UpgradeType::FILESYSTEM) {
+        begin = Update.begin(UPDATE_SIZE_UNKNOWN, U_SPIFFS);
+      }
+      #endif
+
+      if (!begin || Update.hasError()) {
+        result->status = UpgradeStatus::ERROR_ON_START;
+        #ifdef ARDUINO_ARCH_ESP8266
+        result->error = Update.getErrorString();
+        #else
+        result->error = Update.errorString();
+        #endif
+
+        Log.serrorln("PORTAL.OTA", F("File '%s', on start: %s"), upload.filename.c_str(), result->error.c_str());
+        return;
+      }
+      
+      Log.sinfoln("PORTAL.OTA", F("File '%s', started"), upload.filename.c_str());
+
+    } else if (upload.status == UPLOAD_FILE_WRITE) {
+      if (Update.write(upload.buf, upload.currentSize) != upload.currentSize) {
+        Update.end(false);
+
+        result->status = UpgradeStatus::ERROR_ON_WRITE;
+        #ifdef ARDUINO_ARCH_ESP8266
+        result->error = Update.getErrorString();
+        #else
+        result->error = Update.errorString();
+        #endif
+
+        Log.serrorln(
+          "PORTAL.OTA",
+          F("File '%s', on writing %d bytes: %s"),
+          upload.filename.c_str(), upload.totalSize, result->error
+        );
+
+      } else {
+        Log.sinfoln("PORTAL.OTA", F("File '%s', writed %d bytes"), upload.filename.c_str(), upload.totalSize);
+      }
+
+    } else if (upload.status == UPLOAD_FILE_END) {
+      if (Update.end(true)) {
+        result->status = UpgradeStatus::SUCCESS;
+
+        Log.sinfoln("PORTAL.OTA", F("File '%s': finish"), upload.filename.c_str());
+
+      } else {
+        result->status = UpgradeStatus::ERROR_ON_FINISH;
+        #ifdef ARDUINO_ARCH_ESP8266
+        result->error = Update.getErrorString();
+        #else
+        result->error = Update.errorString();
+        #endif
+
+        Log.serrorln("PORTAL.OTA", F("File '%s', on finish: %s"), upload.filename.c_str(), result->error);
+      }
+
+    } else if (upload.status == UPLOAD_FILE_ABORTED) {
+      Update.end(false);
+      result->status = UpgradeStatus::ABORTED;
+
+      Log.serrorln("PORTAL.OTA", F("File '%s': aborted"), upload.filename.c_str());
+    }
+  }
+
+protected:
+  CanHandleFunction canHandleFn;
+  CanUploadFunction canUploadFn;
+  BeforeUpgradeFunction beforeUpgradeFn;
+  AfterUpgradeFunction afterUpgradeFn;
+  const char* uri = nullptr;
+
+  UpgradeResult firmwareResult{UpgradeType::FIRMWARE, UpgradeStatus::NONE};
+  UpgradeResult filesystemResult{UpgradeType::FILESYSTEM, UpgradeStatus::NONE};
+};