HttpClient.h

Go to the documentation of this file.

/* Copyright 2013-2019 Homegear GmbH
 *
 * libhomegear-base is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * libhomegear-base is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with libhomegear-base.  If not, see
 * <http://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give
 * permission to link the code of portions of this program with the
 * OpenSSL library under certain conditions as described in each
 * individual source file, and distribute linked combinations
 * including the two.
 * You must obey the GNU Lesser General Public License in all respects
 * for all of the code used other than OpenSSL.  If you modify
 * file(s) with this exception, you may extend this exception to your
 * version of the file(s), but you are not obligated to do so.  If you
 * do not wish to do so, delete this exception statement from your
 * version.  If you delete this exception statement from all source
 * files in the program, then also delete it here.
*/

#ifndef HTTPCLIENT_H_
#define HTTPCLIENT_H_

#include "../Exception.h"
#include "../Managers/FileDescriptorManager.h"
#include "../Encoding/Http.h"
#include "TcpSocket.h"

namespace BaseLib {
class HttpClientException : public Exception {
 private:
  int32_t _responseCode = -1;
 public:
  explicit HttpClientException(const std::string &message) : Exception(message) {}
  HttpClientException(const std::string &message, int32_t responseCode) : Exception(message), _responseCode(responseCode) {}

  int32_t responseCode() const { return _responseCode; }
};

class HttpClientTimeOutException : public HttpClientException {
 public:
  explicit HttpClientTimeOutException(const std::string &message) : HttpClientException(message) {}
};

class HttpClientSocketClosedException : public HttpClientException {
 public:
  explicit HttpClientSocketClosedException(const std::string &message) : HttpClientException(message) {}
};

class HttpClient {
 public:
  HttpClient(BaseLib::SharedObjects *baseLib, std::string hostname, int32_t port = 80, bool keepAlive = true, bool useSSL = false, std::string caFile = "", bool verifyCertificate = true, std::string certPath = "", std::string keyPath = "");

  HttpClient(BaseLib::SharedObjects *baseLib,
             std::string hostname,
             int32_t port,
             bool keepAlive,
             bool useSSL,
             bool verifyCertificate,
             std::string caFile,
             std::string caData,
             std::string certPath,
             std::string certData,
             std::string keyPath,
             const std::shared_ptr<Security::SecureVector<uint8_t>> &keyData);

  virtual ~HttpClient();

  std::shared_ptr<TcpSocket> getSocket() { return _socket; }

  void setTimeout(uint32_t value);

  void setVerifyHostname(bool value);

  void setUserAgent(const std::string &value);

  bool connected() { return _socket && _socket->connected(); }

  void disconnect() { if (_socket) _socket->close(); }

  void enableRawContent(bool value) { _keepRawContent = value; }

  std::vector<char> &getRawContent() { return _rawContent; }

  std::string getIpAddress() { return _socket ? _socket->getIpAddress() : ""; }

  /*
   * Sends an HTTP request and returns the response.
   *
   * @param[in] request The HTTP request including the full header.
   * @param[out] response The HTTP response without the header.
   */
  void sendRequest(const std::string &request, std::string &response, bool responseIsHeaderOnly = false);

  /*
   * Sends an HTTP request and returns the http object.
   *
   * @param[in] request The HTTP request including the full header.
   * @param[out] response The HTTP response.
   */
  void sendRequest(const std::string &request, Http &response, bool responseIsHeaderOnly = false);

  /*
   * Sends an HTTP GET request and returns the response. This method can be used to download files.
   *
   * @param[in] url The path of the file to get.
   * @param[out] data The data returned.
   */
  void delete_(const std::string &path, std::string &data, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP DELETE request and returns the response. This method can be used to download files.
   *
   * @param[in] url The path of the file to get.
   * @param[out] data The data returned.
   */
  void delete_(const std::string &path, Http &data, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP DELETE request and returns the response. This method can be used to download files.
   *
   * @param[in] url The path of the file to get.
   * @param[out] data The data returned.
   */
  void get(const std::string &path, std::string &data, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP GET request and returns the response. This method can be used to download files.
   *
   * @param[in] url The path of the file to get.
   * @param[out] data The data returned.
   */
  void get(const std::string &path, Http &data, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP PATCH request and returns the response.
   *
   * @param[in] url The path to post to.
   * @param[in] dataIn The POST data.
   * @param[out] dataOut The data returned.
   */
  void patch(const std::string &path, std::string &dataIn, std::string &dataOut, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP PATCH request and returns the response.
   *
   * @param[in] url The path to post to.
   * @param[in] dataIn The POST data.
   * @param[out] dataOut The data returned.
   */
  void patch(const std::string &path, std::string &dataIn, Http &dataOut, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP POST request and returns the response.
   *
   * @param[in] url The path to post to.
   * @param[in] dataIn The POST data.
   * @param[out] dataOut The data returned.
   */
  void post(const std::string &path, std::string &dataIn, std::string &dataOut, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP POST request and returns the response.
   *
   * @param[in] url The path to post to.
   * @param[in] dataIn The POST data.
   * @param[out] dataOut The data returned.
   */
  void post(const std::string &path, std::string &dataIn, Http &dataOut, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP PUT request and returns the response.
   *
   * @param[in] url The path to post to.
   * @param[in] dataIn The POST data.
   * @param[out] dataOut The data returned.
   */
  void put(const std::string &path, std::string &dataIn, std::string &dataOut, const std::string &additionalHeaders = "");

  /*
   * Sends an HTTP PUT request and returns the response.
   *
   * @param[in] url The path to post to.
   * @param[in] dataIn The POST data.
   * @param[out] dataOut The data returned.
   */
  void put(const std::string &path, std::string &dataIn, Http &dataOut, const std::string &additionalHeaders = "");
 protected:
  BaseLib::SharedObjects *_bl = nullptr;

  std::mutex _socketMutex;

  std::shared_ptr<TcpSocket> _socket;

  std::string _hostname = "";

  int32_t _port = 80;

  bool _keepAlive = true;

  bool _keepRawContent = false;

  std::string _userAgent = "Homegear";

  std::vector<char> _rawContent;
};

}
#endif