1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
/* 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"
#include "curl/curl.h"
#include <map>
#include <string>
#include <string_view>
#include <variant>
#include <vector>
namespace mastodonpp
{
using std::map;
using std::string;
using std::string_view;
using std::variant;
using std::vector;
/*!
* @brief The HTTP method.
*
* @since 0.1.0
*/
enum class http_method
{
GET,
POST,
PATCH,
PUT,
DELETE
};
/*!
* @brief std::map of parameters for API calls.
*
* Example:
* @code
* parametermap parameters
* {
* {"id", "12"},
* {"poll[options]", vector<string_view>{"Yes", "No", "Maybe"}}
* };
* @endcode
*
* @since 0.1.0
*/
using parametermap = map<string_view, variant<string_view, vector<string_view>>>;
/*!
* @brief Handles the details of network connections.
*
* 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;
/*!
* @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;
}
/*!
* @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
*/
void set_proxy(const string_view proxy);
protected:
/*!
* @brief Make a HTTP request.
*
* @param method The HTTP method.
* @param uri The full URI.
* @param parameters A map of parameters.
*
* @since 0.1.0
*/
[[nodiscard]]
answer_type make_request(const http_method &method, string uri,
const parametermap ¶meters);
private:
CURL *_connection;
char _curl_buffer_error[CURL_ERROR_SIZE];
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
|
