v2.4

Author: s60sc

ESP32_AdBlocker.ino

@@ -7,7 +7,7 @@
    Currently it does not have an IPv6 address and some devices use IPv6 by default, so disable IPv6 DNS on 
    your device / router to force it to use IPv4 DNS.
 
-   Blocklist files can downloaded from hosting sites and should either be in HOSTS format 
+   Blocklist files can be downloaded from hosting sites and should either be in HOSTS format 
    or Adblock format (only domain name entries processed)
 
    arduino-esp32 library DNSServer.cpp modified as custom AdBlockerDNSServer.cpp so that DNSServer::processNextRequest()

README.md

@@ -29,7 +29,7 @@ To switch back to usual DNS Server, eg Google, enter:
 
 Download github files into the Arduino IDE sketch folder, removing `-main` from the application folder name.
 
-Compile using arduino core v2.x or V3.x with PSRAM enabled and the following Partition scheme:
+Compile using arduino core v2.x or V3.x (min v3.0.3) with PSRAM enabled and the following Partition scheme:
 * ESP32-S3 - `8M with spiffs (...)`
 * ESP32 - `Minimal SPIFFS (...)`
 

appGlobals.h

@@ -22,9 +22,10 @@
 #define DBG_ON false // esp debug output
 #define DOT_MAX 50
 #define HOSTNAME_GRP 0
+#define USE_IP6 false
 
 #define APP_NAME "ESP32_AdBlocker" // max 15 chars
-#define APP_VER "2.3"
+#define APP_VER "2.4"
 
 #define HTTP_CLIENTS 2 // http, ws
 #define MAX_STREAMS 0
@@ -56,7 +57,7 @@
 #define EXTPIN 100
 
 // to determine if newer data files need to be loaded
-#define CFG_VER 2
+#define CFG_VER 3
 
 #ifdef CONFIG_IDF_TARGET_ESP32S3 
 #define SERVER_STACK_SIZE (1024 * 8)

appSpecific.cpp

@@ -134,7 +134,7 @@ static bool downloadBlockList() {
   // download blocklist file from web
   bool res = false;
   WiFiClientSecure wclient;
-  if (remoteServerConnect(wclient, GITHUB_HOST, HTTPS_PORT, git_rootCACertificate)) {
+  if (remoteServerConnect(wclient, GITHUB_HOST, HTTPS_PORT, git_rootCACertificate, BLOCKLIST)) {
     HTTPClient https;
     size_t downloadSize = 0;
     char progStr[10];
@@ -263,7 +263,7 @@ void showBlockList(int maxItems) {
 
 /************************ webServer callbacks *************************/
 
-bool updateAppStatus(const char* variable, const char* value) {
+bool updateAppStatus(const char* variable, const char* value, bool fromUser) {
   // update vars from configs and browser input
   bool res = true;
   int intVal = atoi(value);

globals.h

@@ -26,12 +26,16 @@
 #include "ping/ping_sock.h"
 #include <Preferences.h>
 #include <regex>
+#if !CONFIG_IDF_TARGET_ESP32C3
 #include <SD_MMC.h>
+#endif
 #include <LittleFS.h>
 #include <sstream>
 #include <Update.h>
 #include <WiFi.h>
 #include <HTTPClient.h>
+////#include <NetworkClient.h> // v3.x only
+////#include <NetworkClientSecure.h> // v3.x only
 #include <WiFiClient.h>
 #include <WiFiClientSecure.h>
 #include <esp_http_server.h>
@@ -57,6 +61,7 @@
 #define CSS_EXT ".css"
 #define ICO_EXT ".ico"
 #define SVG_EXT ".svg"
+#define JPG_EXT ".jpg"
 #define CONFIG_FILE_PATH DATA_DIR "/configs" TEXT_EXT
 #define LOG_FILE_PATH DATA_DIR "/log" TEXT_EXT
 #define OTA_FILE_PATH DATA_DIR "/OTA" HTML_EXT
@@ -80,6 +85,8 @@
 #define NULL_TEMP -127
 #define OneMHz 1000000
 #define USECS 1000000
+#define MAGIC_NUM 987654321
+#define MAX_FAIL 5
 
 // global mandatory app specific functions, in appSpecific.cpp 
 bool appDataFiles();
@@ -89,7 +96,7 @@ void appSpecificWsBinHandler(uint8_t* wsMsg, size_t wsMsgLen);
 void appSpecificWsHandler(const char* wsMsg);
 void appSpecificTelegramTask(void* p);
 void buildAppJsonString(bool filter);
-bool updateAppStatus(const char* variable, const char* value);
+bool updateAppStatus(const char* variable, const char* value, bool fromUser = true);
 
 // global general utility functions in utils.cpp / utilsFS.cpp / peripherals.cpp    
 void buildJsonString(uint8_t filter);
@@ -151,7 +158,8 @@ float readTemperature(bool isCelsius, bool onlyDS18 = false);
 float readVoltage();
 void remote_log_init();
 void remoteServerClose(WiFiClientSecure& sclient);
-bool remoteServerConnect(WiFiClientSecure& sclient, const char* serverName, uint16_t serverPort, const char* serverCert);
+bool remoteServerConnect(WiFiClientSecure& sclient, const char* serverName, uint16_t serverPort, const char* serverCert, uint8_t connIdx);
+void remoteServerReset();
 void removeChar(char* s, char c);
 void replaceChar(char* s, char c, char r);
 void reset_log();
@@ -173,7 +181,7 @@ bool startWifi(bool firstcall = true);
 void stopPing();
 void syncToBrowser(uint32_t browserUTC);
 bool updateConfigVect(const char* variable, const char* value);
-void updateStatus(const char* variable, const char* _value);
+void updateStatus(const char* variable, const char* _value, bool fromUser = true);
 esp_err_t uploadHandler(httpd_req_t *req);
 void urlDecode(char* inVal);
 bool urlEncode(const char* inVal, char* encoded, size_t maxSize);
@@ -184,6 +192,7 @@ void wsAsyncSend(const char* wsData);
 void startMqttClient();  
 void stopMqttClient();  
 void mqttPublish(const char* payload);
+void mqttPublishPath(const char* suffix, const char* payload);
 // telegram.cpp
 bool getTgramUpdate(char* response);
 bool sendTgramMessage(const char* info, const char* item, const char* parseMode);
@@ -258,13 +267,6 @@ extern char mqtt_user[];
 extern char mqtt_user_Pass[];
 extern char mqtt_topic_prefix[];  
 
-// External Heartbeat
-extern bool external_heartbeat_active;
-extern char external_heartbeat_domain[]; //External Heartbeat domain/IP  
-extern char external_heartbeat_uri[];    //External Heartbeat uri (i.e. /myesp32-cam-hub/index.php)
-extern char external_heartbeat_port[];   //External Heartbeat server port to connect.  
-extern char external_heartbeat_token[];  //External Heartbeat server auth token.  
-
 // control sending alerts 
 extern size_t alertBufferSize;
 extern byte* alertBuffer;
@@ -347,6 +349,8 @@ extern bool formatIfMountFailed ; // Auto format the file system if mount failed
   (method == HTTP_UNLINK) ? "UNLINK" : \
   "UNKNOWN"
 
+enum RemoteFail {SETASSIST, GETEXTIP, TGRAMCONN, FSFTP, EMAILCONN, EXTERNALHB, BLOCKLIST, REMFAILCNT}; // REMFAILCNT always last
+
 /*********************** Log formatting ************************/
 
 //#define USE_LOG_COLORS  // uncomment to colorise log messages (eg if using idf.py, but not arduino)

prefs.cpp

@@ -60,7 +60,13 @@ void showConfigVect() {
 }
 
 void reloadConfigs() {
-  while (getNextKeyVal()) updateStatus(variable, value);
+  while (getNextKeyVal()) updateStatus(variable, value, false);
+#if INCLUDE_MQTT
+  if (mqtt_active) {
+    buildJsonString(1);
+    mqttPublishPath("config", jsonBuff);
+  }
+#endif
 }
 
 static int getKeyPos(std::string thisKey) {
@@ -221,7 +227,7 @@ static bool loadPrefs() {
   return true;
 }
 
-void updateStatus(const char* variable, const char* _value) {
+void updateStatus(const char* variable, const char* _value, bool fromUser) {
   // called from controlHandler() to update app status from changes made on browser
   // or from loadConfig() to update app status from stored preferences
   bool res = true;
@@ -301,8 +307,7 @@ void updateStatus(const char* variable, const char* _value) {
 #if INCLUDE_MQTT
   else if (!strcmp(variable, "mqtt_active")) {
     mqtt_active = (bool)intVal;
-    if (mqtt_active) startMqttClient();
-    else stopMqttClient();
+    if (!mqtt_active) stopMqttClient();
   } 
   else if (!strcmp(variable, "mqtt_broker")) strncpy(mqtt_broker, value, MAX_HOST_LEN-1);
   else if (!strcmp(variable, "mqtt_port")) strncpy(mqtt_port, value, 4);
@@ -353,7 +358,7 @@ void updateStatus(const char* variable, const char* _value) {
     if (intVal) savePrefs();
     saveConfigVect();
   } else {
-    res = updateAppStatus(variable, value);
+    res = updateAppStatus(variable, value, fromUser);
     if (!res) LOG_VRB("Unrecognised config: %s", variable);
   }
   if (res) updateConfigVect(variable, value);  
@@ -508,7 +513,6 @@ bool loadConfig() {
     loadConfigVect();
     //showConfigVect();
     loadPrefs(); // overwrites any corresponding entries in config
-
     // load variables from stored config vector
     reloadConfigs();
     debugMemory("loadConfig");

setupAssist.cpp

@@ -28,7 +28,7 @@ static bool wgetFile(const char* filePath) {
     File f = fp.open(filePath, FILE_WRITE);
     if (f) {
       WiFiClientSecure wclient;
-      if (remoteServerConnect(wclient, GITHUB_HOST, HTTPS_PORT, git_rootCACertificate)) {
+      if (remoteServerConnect(wclient, GITHUB_HOST, HTTPS_PORT, git_rootCACertificate, SETASSIST)) {
         HTTPClient https;
         if (https.begin(wclient, GITHUB_HOST, HTTPS_PORT, downloadURL, true)) {
           LOG_INF("Downloading %s from %s", filePath, downloadURL);    
@@ -37,14 +37,14 @@ static bool wgetFile(const char* filePath) {
           if (httpCode == HTTP_CODE_OK) {
             fileSize = https.writeToStream(&f);
             if (fileSize <= 0) {
+              LOG_WRN("Download failed: writeToStream - %s", https.errorToString(fileSize).c_str());
               httpCode = 0;
-              LOG_WRN("Download failed: writeToStream");
             } else LOG_INF("Downloaded %s, size %s", filePath, fmtSize(fileSize));       
           } else LOG_WRN("Download failed, error: %s", https.errorToString(httpCode).c_str());    
           https.end();
           f.close();
           if (httpCode == HTTP_CODE_OK) {
-            if (!strcmp(filePath, CONFIG_FILE_PATH)) doRestart("config file downloaded");
+            if (!strcmp(filePath, CONFIG_FILE_PATH)) doRestart("Config file downloaded");
             res = true;
           } else {
             LOG_WRN("HTTP Get failed with code: %d", httpCode);