URLStreamESP32.h

Go to the documentation of this file.

#pragma once
 
#include "AudioTools/Communication/HTTP/AbstractURLStream.h"
#include "AudioTools/Communication/HTTP/HttpRequest.h"
#include "AudioTools/Communication/HTTP/ICYStreamT.h"
#include "AudioTools/Communication/HTTP/URLStreamBufferedT.h"
#include "AudioTools/Communication/Network/WiFiESP32.h"
#include "esp_http_client.h"
#include "esp_idf_version.h"
#include "esp_system.h"
#include "esp_wifi.h"
#include "nvs_flash.h"
 
namespace audio_tools {
 
class URLStreamESP32;
static URLStreamESP32* actualURLStreamESP32 = nullptr;
 
class URLStreamESP32 : public AbstractURLStream {
 public:
  URLStreamESP32(const char* ssid, const char* pwd) {
    setSSID(ssid);
    setPassword(pwd);
    _timeout = URL_CLIENT_TIMEOUT;
  }
  URLStreamESP32() : URLStreamESP32(nullptr, nullptr) {}
  ~URLStreamESP32() { end(); }
  // executes the URL request
  virtual bool begin(const char* urlStr, const char* acceptMime = "",
                     MethodID action = GET, const char* reqMime = "",
                     const char* reqData = "") {
    TRACED();
    if (client_handle != nullptr) {
      end();
    }
    total_read = 0;
    url_str = urlStr;
    content_length = 0;
    // start wifi if necessary and possible
    if (ssid != nullptr) {
      if (!IDF_WIFI.begin(ssid, password)) {
        LOGE("Wifi failed");
        return false;
      }
      if (!IDF_WIFI.isConnected()) {
        // wait for connection
        Serial.print("Waiting for connection ");
        while (!IDF_WIFI.isConnected()) {
          delay(200);
          Serial.print(".");
        }
        Serial.println();
      }
    }
 
    // for headers
    actualURLStreamESP32 = this;
 
    // determine wifi country
    wifi_country_t cntry;
    memset(&cntry, 0, sizeof(wifi_country_t));
    esp_wifi_get_country(&cntry);
    char text[4] = {0};
    strncpy(text, cntry.cc, 3);
    LOGI("wifi country: %s", text);
 
    // fill http_config
    esp_http_client_config_t http_config;
    memset(&http_config, 0, sizeof(http_config));
    http_config.url = urlStr;
    http_config.user_agent = DEFAULT_AGENT;
    http_config.event_handler = http_event_handler;
    http_config.buffer_size = buffer_size;
    http_config.timeout_ms = _timeout;
    http_config.user_data = this;
    // for SSL certificate
    if (pem_cert != nullptr) {
      http_config.cert_pem = (const char*)pem_cert;
      http_config.cert_len = pem_cert_len;
    }
    // for SSL (use of a bundle for certificate verification)
    if (crt_bundle_attach != nullptr) {
      http_config.crt_bundle_attach = crt_bundle_attach;
    }
 
    switch (action) {
      case GET:
        http_config.method = HTTP_METHOD_GET;
        break;
      case POST:
        http_config.method = HTTP_METHOD_POST;
        break;
      case PUT:
        http_config.method = HTTP_METHOD_PUT;
        break;
      case DELETE:
        http_config.method = HTTP_METHOD_DELETE;
        break;
      default:
        LOGE("Unsupported action: %d", action);
        break;
    }
 
    // Init only the first time
    if (client_handle == nullptr) {
      client_handle = esp_http_client_init(&http_config);
    }
 
    // process header parameters
    if (!StrView(acceptMime).isEmpty()) addRequestHeader(ACCEPT, acceptMime);
    if (!StrView(reqMime).isEmpty()) addRequestHeader(CONTENT_TYPE, reqMime);
    List<HttpHeaderLine*>& lines = request.header().getHeaderLines();
    for (auto it = lines.begin(); it != lines.end(); ++it) {
      if ((*it)->active) {
        esp_http_client_set_header(client_handle, (*it)->key.c_str(),
                                   (*it)->value.c_str());
      }
    }
 
    // Open http
    if (esp_http_client_open(client_handle, 0) != ESP_OK) {
      LOGE("esp_http_client_open");
      return false;
    }
 
    // Determine the result
    content_length = esp_http_client_fetch_headers(client_handle);
    int status_code = esp_http_client_get_status_code(client_handle);
    LOGI("status_code: %d / content_length: %d", status_code, content_length);
 
    // Process post/put data
    StrView data(reqData);
    if (!data.isEmpty()) {
      write((const uint8_t*)reqData, data.length());
    }
 
    return status_code == 200;
  }
  // ends the request
  virtual void end() override {
    if (client_handle == nullptr) return;
    esp_http_client_close(client_handle);
    esp_http_client_cleanup(client_handle);
    client_handle = nullptr;
  }
 
  int availableForWrite() override { return 1024; }
 
  virtual void setSSID(const char* ssid) { this->ssid = ssid; }
 
  virtual void setPassword(const char* password) { this->password = password; }
 
  virtual void setPowerSave(bool ps) {
    IDF_WIFI.setPowerSave(ps ? WIFI_PS_MAX_MODEM : WIFI_PS_NONE);
  }
 
  size_t write(const uint8_t* data, size_t len) override {
    TRACED();
    int written = esp_http_client_write(client_handle, (const char*)data, len);
    if (written < 0) {
      LOGE("esp_http_client_write: %d", written);
      return 0;
    }
    return written;
  }
 
  size_t readBytes(uint8_t* data, size_t len) override {
    TRACED();
    int read = esp_http_client_read(client_handle, (char*)data, len);
    if (read < 0) {
      LOGE("esp_http_client_read: %d", read);
      return 0;
    }
    total_read += read;
    return read;
  }
 
  void addRequestHeader(const char* key, const char* value) override {
    TRACED();
    request.addRequestHeader(key, value);
  }
  const char* getReplyHeader(const char* key) override {
    return request.getReplyHeader(key);
  }
 
  void setCACert(const char* cert) override {
    int len = strlen(cert);
    setCACert((const uint8_t*)cert, len + 1);
  }
 
  void setCACert(esp_err_t (*cb)(void* conf)) { crt_bundle_attach = cb; }
 
  void setReadBufferSize(int size) { buffer_size = size; }
 
  HttpRequest& httpRequest() override { return request; }
 
  void setClient(Client& client) override {}
 
  const char* urlStr() override { return  (char*)url_str; }
 
  size_t totalRead() override { return total_read; }
 
  int contentLength() override { return content_length; }
 
  virtual bool waitForData(int timeout) override{ return false; }
  void setConnectionClose(bool flag) override {}
 
 protected:
  int id = 0;
  HttpRequest request;
  esp_http_client_handle_t client_handle = nullptr;
  bool is_power_save = false;
  const char* ssid = nullptr;
  const char* password = nullptr;
  int buffer_size = DEFAULT_BUFFER_SIZE;
  const uint8_t* pem_cert = nullptr;
  int pem_cert_len = 0;
  esp_err_t (*crt_bundle_attach)(void* conf) = nullptr;
  size_t total_read = 0;
  const char* url_str = nullptr;
  int content_length = 0;
 
  void setCACert(const uint8_t* cert, int len) {
    pem_cert_len = len;
    pem_cert = cert;
    // certificate must end with traling null
    assert(cert[len - 1] == 0);
  }
 
  static esp_err_t http_event_handler(esp_http_client_event_t* evt) {
    switch (evt->event_id) {
      case HTTP_EVENT_ERROR:
        LOGI("HTTP_EVENT_ERROR");
        break;
      case HTTP_EVENT_ON_CONNECTED:
        LOGD("HTTP_EVENT_ON_CONNECTED");
        break;
      case HTTP_EVENT_HEADER_SENT:
        LOGD("HTTP_EVENT_HEADER_SENT");
        break;
      case HTTP_EVENT_ON_HEADER:
        LOGI("HTTP_EVENT_ON_HEADER, key=%s, value=%s", evt->header_key,
             evt->header_value);
        // store reply headers
        actualURLStreamESP32->request.reply().put(evt->header_key,
                                                  evt->header_value);
        break;
      case HTTP_EVENT_ON_DATA:
        LOGD("HTTP_EVENT_ON_DATA, len=%d", evt->data_len);
        break;
      case HTTP_EVENT_ON_FINISH:
        LOGI("HTTP_EVENT_ON_FINISH");
        break;
      case HTTP_EVENT_DISCONNECTED:
        LOGI("HTTP_EVENT_DISCONNECTED");
        break;
#if ESP_IDF_VERSION > ESP_IDF_VERSION_VAL(5, 3, 7)
      case HTTP_EVENT_REDIRECT:
        LOGI("HTTP_EVENT_REDIRECT");
        break;
#endif
    }
    return ESP_OK;
  }
};
 
using ICYStreamESP32 = ICYStreamT<URLStreamESP32>;
#if defined(USE_CONCURRENCY)
using URLStreamBufferedESP32 = URLStreamBufferedT<URLStreamESP32>;
using ICYStreamBufferedESP32 = URLStreamBufferedT<ICYStreamESP32>;
#endif
 
#if !defined(ARDUINO)
using URLStream = URLStreamESP32;
using URLStreamBuffered = URLStreamBufferedESP32;
using ICYStreamBuffered = ICYStreamBufferedESP32;
#endif
 
}  // namespace audio_tools