HttpRequest.h

Go to the documentation of this file.

#pragma once
 
#include "AudioToolsConfig.h"
#include "HttpChunkReader.h"
#include "HttpHeader.h"
#include "HttpTypes.h"
#include "Url.h"
#include "AudioLogger.h"
 
#define CHUNK_SIZE 1024
 
namespace audio_tools {
 
class HttpRequest : public BaseStream {
 public:
//  friend class URLStream;
 
  HttpRequest(){
    chunk_reader.setTimeout(client_timeout);
  };
 
  ~HttpRequest() { end(); }
 
  HttpRequest(Client &client) : HttpRequest() { setClient(client); }
 
  void setClient(Client &client) {
    this->client_ptr = &client;
    this->client_ptr->setTimeout(client_timeout);
 
  }
 
  // the requests usually need a host. This needs to be set if we did not
  // provide a URL
  void setHost(const char *host) {
    LOGI("setHost %s", host);
    this->host_name = host;
  }
 
  operator bool() { return client_ptr != nullptr ? (bool)*client_ptr : false; }
 
  virtual bool connected() {
    return client_ptr == nullptr ? false : client_ptr->connected();
  }
 
  int available() override {
    if (reply_header.isChunked()) {
      return chunk_reader.available();
    }
    return client_ptr != nullptr ? client_ptr->available() : 0;
  }
 
  void end() override {
    if (connected()) {
      // write final 0 chunk if necessary
      if (is_chunked_output_active) {
        client_ptr->println(0, HEX);
        client_ptr->println();
        client_ptr->flush();
        is_chunked_output_active = false;
      }
      LOGI("stop");
      client_ptr->stop();
    }
  }
 
  virtual void stop() {
    end();
  }
 
  virtual int post(Url &url, const char *mime, const char *data, int len = -1) {
    LOGI("post %s", url.url());
    return process(POST, url, mime, data, len);
  }
 
  virtual int post(Url &url, const char *mime, Stream &data, int len = -1) {
    LOGI("post %s", url.url());
    return process(POST, url, mime, data, len);
  }
 
  virtual int put(Url &url, const char *mime, const char *data, int len = -1) {
    LOGI("put %s", url.url());
    return process(PUT, url, mime, data, len);
  }
 
  virtual int put(Url &url, const char *mime, Stream &data, int len = -1) {
    LOGI("put %s", url.url());
    return process(PUT, url, mime, data, len);
  }
 
  virtual int del(Url &url, const char *mime = nullptr,
                  const char *data = nullptr, int len = -1) {
    LOGI("del %s", url.url());
    return process(DELETE, url, mime, data, len);
  }
 
  virtual int get(Url &url, const char *acceptMime = nullptr,
                  const char *data = nullptr, int len = -1) {
    LOGI("get %s", url.url());
    this->accept = acceptMime;
    return process(GET, url, nullptr, data, len);
  }
 
  virtual int head(Url &url, const char *acceptMime = nullptr,
                   const char *data = nullptr, int len = -1) {
    LOGI("head %s", url.url());
    this->accept = acceptMime;
    return process(HEAD, url, nullptr, data, len);
  }
 
  // reads the reply data
  virtual int read(uint8_t *str, int len) {
    TRACED();
    if (reply_header.isChunked()) {
      return chunk_reader.read(*client_ptr, str, len);
    } else {
      return client_ptr->read(str, len);
    }
  }
 
  size_t readBytes(uint8_t *str, size_t len) override {
    int result = read(str, len);
    if ( result < 0) {
      LOGE("HttpRequest::read error");
      return 0;
    }
    return result;
  }
 
  size_t readBytesUntil(char terminator, char *buffer, size_t length) {
    TRACED();
    return client_ptr->readBytesUntil(terminator, buffer, length);
  }
 
  // read the reply data up to the next new line. For Chunked data we provide
  // the full chunk!
  virtual int readln(uint8_t *str, int len, bool incl_nl = true) {
    TRACED();
    if (reply_header.isChunked()) {
      return chunk_reader.readln(*client_ptr, str, len);
    } else {
      return chunk_reader.readlnInternal(*client_ptr, str, len, incl_nl);
    }
  }
 
  // provides the head information of the reply
  virtual HttpReplyHeader &reply() { return reply_header; }
 
  virtual HttpRequestHeader &header() { return request_header; }
 
  virtual void setAgent(const char *agent) { this->agent = agent; }
 
  virtual void setConnection(const char *connection) {
    this->connection = connection;
  }
 
  virtual void setAcceptsEncoding(const char *enc) {
    this->accept_encoding = enc;
  }
 
  virtual void setAcceptMime(const char *mime) { this->accept = mime; }
 
  size_t contentLength() {
    const char *len_str = reply().get(CONTENT_LENGTH);
    int len = 0;
    if (len_str != nullptr) {
      len = atoi(len_str);
    } else {
      LOGI("no CONTENT_LENGTH found in reply");
    }
    return len;
  }
 
  bool isReady() { return is_ready; }
 
  void addRequestHeader(const char *key, const char *value) {
    request_header.put(key, value);
  }
  const char* getReplyHeader(const char *key) {
    return reply_header.get(key);
  }
 
  Client &client() { return *client_ptr; }
 
  // process http request and reads the reply_header from the server
  virtual int process(MethodID action, Url &url, const char *mime,
                      const char *data, int lenData = -1) {
    int len = lenData;
    if (data != nullptr && len <= 0) {
      len = strlen(data);
    }
    processBegin(action, url, mime, len);
    // posting data parameter
    if (len > 0 && data != nullptr) {
      LOGI("Writing data: %d bytes", len);
      client_ptr->write((const uint8_t *)data, len);
      LOGD("%s", data);
    }
    return processEnd();
  }
 
  // process http request and reads the reply_header from the server
  virtual int process(MethodID action, Url &url, const char *mime,
                      Stream &stream, int len = -1) {
    if (!processBegin(action, url, mime, len))
      return -1;
    processWrite(stream);
    return processEnd();
  }
 
  virtual bool processBegin(MethodID action, Url &url, const char *mime,
                            int lenData = -1) {
    TRACED();
    int len = lenData;
    is_ready = false;
    if (client_ptr == nullptr) {
      LOGE("The client has not been defined");
      return false;
    }
    if (http_connect_callback) {
      http_connect_callback(*this, url, request_header);
    }
    if (!this->connected()) {
      LOGI("process connecting to host %s port %d", url.host(), url.port());
      int is_connected = connect(url.host(), url.port(), client_timeout);
      if (!is_connected) {
        LOGE("Connect failed");
        return false;
      }
    } else {
      LOGI("process is already connected");
    }
 
#if defined(ESP32) && defined(ARDUINO)
    LOGI("Free heap: %u", (unsigned)ESP.getFreeHeap());
#endif
 
    reply_header.setProcessed();
 
    host_name = url.host();
    request_header.setValues(action, url.path());
    if (lenData > 0) {
      request_header.put(CONTENT_LENGTH, lenData);
    }
    request_header.put(HOST_C, host_name);
    request_header.put(CONNECTION, connection);
    request_header.put(USER_AGENT, agent);
    request_header.put(ACCEPT_ENCODING, accept_encoding);
    request_header.put(ACCEPT, accept);
    request_header.put(CONTENT_TYPE, mime);
    request_header.write(*client_ptr);
 
    return true;
  }
 
  virtual void processWrite(Stream &stream) {
    uint8_t buffer[CHUNK_SIZE];
    int total = 0;
    int total_written = 0;
    while (*client_ptr && stream.available() > 0) {
      int result_len = stream.readBytes(buffer, CHUNK_SIZE);
      total += result_len;
      int written = write(buffer, result_len);
      total_written += written;
      LOGI("--> Bytes read %d vs written %d", result_len, written);
      delay(1);
    }
    client_ptr->flush();
    LOGI("Total bytes read %d vs written %d", total, total_written);
  }
 
  size_t write(const uint8_t *data, size_t len) override {
    TRACED();
    size_t result = 0;
    if (isChunked()) {
      if (len > 0) {
        is_chunked_output_active = true;
        client_ptr->println(len, HEX);
        result = client_ptr->write(data, len);
        client_ptr->println();
      }
    } else {
      result = client_ptr->write(data, len);
    }
    return result;
  }
 
  virtual int processEnd() {
    TRACED();
    // if sending is chunked we terminate with an empty chunk
    if (isChunked()) {
      if (is_chunked_output_active) client_ptr->println(0, HEX);
      client_ptr->println();
      is_chunked_output_active = false;
    }
    LOGI("Request written ... waiting for reply");
    // Commented out because this breaks the RP2040 W
    // client_ptr->flush();
    reply_header.read(*client_ptr);
 
    // if we use chunked tranfer we need to read the first chunked length
    if (reply_header.isChunked()) {
      if (!chunk_reader.open(*client_ptr)) {
        LOGE("HttpRequest: Failed to open chunked reader");
        return -1;
      }
    }
 
    // wait for data
    is_ready = true;
    return reply_header.statusCode();
  }
 
  void setOnConnectCallback(void (*callback)(
      HttpRequest &request, Url &url, HttpRequestHeader &request_header)) {
    http_connect_callback = callback;
  }
 
  void setTimeout(size_t timeoutMs) { 
    client_timeout = timeoutMs;
    chunk_reader.setTimeout(client_timeout);
    if(client_ptr != nullptr){
      client_ptr->setTimeout(timeoutMs);
    }
   }
 
  bool isChunked() { return request_header.isChunked(); }
 
 protected:
  Client *client_ptr = nullptr;
  Url url;
  HttpRequestHeader request_header;
  HttpReplyHeader reply_header;
  HttpChunkReader chunk_reader = HttpChunkReader(reply_header);
  const char *agent = nullptr;
  const char *host_name = nullptr;
  const char *connection = CON_KEEP_ALIVE;
  const char *accept = ACCEPT_ALL;
  const char *accept_encoding = IDENTITY;
  bool is_ready = false;
  int client_timeout = URL_CLIENT_TIMEOUT;  // 10000;
  void (*http_connect_callback)(HttpRequest &request, Url &url,
                                HttpRequestHeader &request_header) = nullptr;
  bool is_chunked_output_active = false;
 
  // opens a connection to the indicated host
  virtual int connect(const char *ip, uint16_t port, int32_t timeout) {
    TRACED();
    client_ptr->setTimeout(timeout);  
    request_header.setTimeout(timeout);
    reply_header.setTimeout(timeout);
    int is_connected = this->client_ptr->connect(ip, port);
    LOGI("is connected %s  with timeout %d", is_connected ? "true" : "false", (int)timeout);
    return is_connected;
  }
};
 
}  // namespace audio_tools