mastodonpp/include/curl_wrapper.hpp

181 lines
4.3 KiB
C++
Raw Normal View History

/* This file is part of mastodonpp.
* Copyright © 2020 tastytea <tastytea@tastytea.de>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, version 3.
*
* This program 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODONPP_CURL_WRAPPER_HPP
#define MASTODONPP_CURL_WRAPPER_HPP
#include "answer.hpp"
2020-01-05 10:35:38 +01:00
#include "curl/curl.h"
2020-01-06 13:29:38 +01:00
#include <map>
#include <string>
2020-01-04 19:04:50 +01:00
#include <string_view>
2020-01-06 13:29:38 +01:00
#include <variant>
#include <vector>
namespace mastodonpp
{
2020-01-06 13:29:38 +01:00
using std::map;
using std::string;
2020-01-04 19:04:50 +01:00
using std::string_view;
2020-01-06 13:29:38 +01:00
using std::variant;
using std::vector;
2020-01-04 19:04:50 +01:00
/*!
* @brief The HTTP method.
*
* @since 0.1.0
*/
2020-01-04 19:04:50 +01:00
enum class http_method
{
GET,
POST,
PATCH,
2020-01-05 16:16:22 +01:00
PUT,
DELETE
2020-01-04 19:04:50 +01:00
};
2020-01-06 13:29:38 +01:00
/*!
* @brief std::map of parameters for API calls.
*
* Example:
* @code
* parametermap parameters
* {
* {"id", "12"},
* {"poll[options]", vector<string_view>{"Yes", "No", "Maybe"}}
2020-01-06 13:29:38 +01:00
* };
* @endcode
*
* @since 0.1.0
*/
using parametermap = map<string_view, variant<string_view, vector<string_view>>>;
2020-01-06 13:29:38 +01:00
/*!
* @brief Handles the details of network connections.
*
2020-01-04 19:09:33 +01:00
* You don't need to use this.
*
* @since 0.1.0
*
* @headerfile curl_wrapper.hpp mastodonpp/curl_wrapper.hpp
*/
class CURLWrapper
{
public:
/*!
* @brief Initializes curl and sets up connection.
*
* The first time an instance of CURLWrapper is created, it calls
* `curl_global_init`, which is not thread-safe. For more information
* consult [curl_global_init(3)]
* (https://curl.haxx.se/libcurl/c/curl_global_init.html).
*
* @since 0.1.0
*/
CURLWrapper();
//! Copy constructor
CURLWrapper(const CURLWrapper &other) = default;
//! Move constructor
CURLWrapper(CURLWrapper &&other) noexcept = default;
/*!
* @brief Cleans up curl and connection.
*
* Calls `curl_global_cleanup`, which is not thread-safe. For more
* information consult [curl_global_cleanup(3)]
* (https://curl.haxx.se/libcurl/c/curl_global_cleanup.html).
*
* @since 0.1.0
*/
virtual ~CURLWrapper() noexcept;
//! Copy assignment operator
CURLWrapper& operator=(const CURLWrapper &other) = default;
//! Move assignment operator
CURLWrapper& operator=(CURLWrapper &&other) noexcept = default;
2020-01-06 15:33:23 +01:00
/*!
* @brief Returns pointer to the CURL easy handle.
*
* You can use this handle to set or modify curl options. For more
* information consult [curl_easy_setopt(3)]
* (https://curl.haxx.se/libcurl/c/curl_easy_setopt.html).
*
* @since 0.1.0
*/
inline CURL *get_curl_easy_handle()
{
return _connection;
}
2020-01-08 17:16:15 +01:00
/*!
* @brief Set the proxy to use.
*
* See [CURLOPT_PROXY(3)]
* (https://curl.haxx.se/libcurl/c/CURLOPT_PROXY.html).
*
* @param proxy Examples: "socks4a://127.0.0.1:9050", "http://[::1]:3128".
*
* @since 0.1.0
*/
2020-01-08 17:38:27 +01:00
void set_proxy(string_view proxy);
2020-01-08 17:16:15 +01:00
2020-01-06 15:33:23 +01:00
protected:
2020-01-04 19:09:33 +01:00
/*!
2020-01-08 12:56:16 +01:00
* @brief Make a HTTP request.
2020-01-04 19:09:33 +01:00
*
2020-01-08 12:56:16 +01:00
* @param method The HTTP method.
* @param uri The full URI.
* @param parameters A map of parameters.
2020-01-04 19:09:33 +01:00
*
* @since 0.1.0
*/
2020-01-04 19:06:27 +01:00
[[nodiscard]]
2020-01-08 12:56:16 +01:00
answer_type make_request(const http_method &method, string uri,
const parametermap &parameters);
2020-01-04 19:04:50 +01:00
private:
CURL *_connection;
char _curl_buffer_error[CURL_ERROR_SIZE];
2020-01-05 12:03:23 +01:00
string _curl_buffer_headers;
string _curl_buffer_body;
/*!
* @brief libcurl write callback function.
*
* @since 0.1.0
*/
static int writer(char *data, size_t size, size_t nmemb,
string *writerData);
/*!
* @brief Setup libcurl connection.
*
* @since 0.1.0
*/
void setup_curl();
};
} // namespace mastodonpp
#endif // MASTODONPP_CURL_WRAPPER_HPP