xref: /aosp_15_r20/external/libbrillo/brillo/http/curl_api.cc (revision 1a96fba65179ea7d3f56207137718607415c5953)
1*1a96fba6SXin Li // Copyright 2014 The Chromium OS Authors. All rights reserved.
2*1a96fba6SXin Li // Use of this source code is governed by a BSD-style license that can be
3*1a96fba6SXin Li // found in the LICENSE file.
4*1a96fba6SXin Li 
5*1a96fba6SXin Li #include <brillo/http/curl_api.h>
6*1a96fba6SXin Li 
7*1a96fba6SXin Li #include <base/logging.h>
8*1a96fba6SXin Li 
9*1a96fba6SXin Li namespace brillo {
10*1a96fba6SXin Li namespace http {
11*1a96fba6SXin Li 
12*1a96fba6SXin Li namespace {
13*1a96fba6SXin Li 
14*1a96fba6SXin Li static_assert(CURLOPTTYPE_LONG == 0 &&
15*1a96fba6SXin Li               CURLOPTTYPE_OBJECTPOINT == 10000 &&
16*1a96fba6SXin Li               CURLOPTTYPE_FUNCTIONPOINT == 20000 &&
17*1a96fba6SXin Li               CURLOPTTYPE_OFF_T == 30000,
18*1a96fba6SXin Li               "CURL option types are expected to be multiples of 10000");
19*1a96fba6SXin Li 
VerifyOptionType(CURLoption option,int expected_type)20*1a96fba6SXin Li inline bool VerifyOptionType(CURLoption option, int expected_type) {
21*1a96fba6SXin Li   int option_type = (static_cast<int>(option) / 10000) * 10000;
22*1a96fba6SXin Li   return (option_type == expected_type);
23*1a96fba6SXin Li }
24*1a96fba6SXin Li 
25*1a96fba6SXin Li }  // anonymous namespace
26*1a96fba6SXin Li 
CurlApi()27*1a96fba6SXin Li CurlApi::CurlApi() {
28*1a96fba6SXin Li   curl_global_init(CURL_GLOBAL_ALL);
29*1a96fba6SXin Li }
30*1a96fba6SXin Li 
~CurlApi()31*1a96fba6SXin Li CurlApi::~CurlApi() {
32*1a96fba6SXin Li   curl_global_cleanup();
33*1a96fba6SXin Li }
34*1a96fba6SXin Li 
EasyInit()35*1a96fba6SXin Li CURL* CurlApi::EasyInit() {
36*1a96fba6SXin Li   return curl_easy_init();
37*1a96fba6SXin Li }
38*1a96fba6SXin Li 
EasyCleanup(CURL * curl)39*1a96fba6SXin Li void CurlApi::EasyCleanup(CURL* curl) {
40*1a96fba6SXin Li   curl_easy_cleanup(curl);
41*1a96fba6SXin Li }
42*1a96fba6SXin Li 
EasySetOptInt(CURL * curl,CURLoption option,int value)43*1a96fba6SXin Li CURLcode CurlApi::EasySetOptInt(CURL* curl, CURLoption option, int value) {
44*1a96fba6SXin Li   CHECK(VerifyOptionType(option, CURLOPTTYPE_LONG))
45*1a96fba6SXin Li       << "Only options that expect a LONG data type must be specified here";
46*1a96fba6SXin Li   // CURL actually uses "long" type, so have to make sure we feed it what it
47*1a96fba6SXin Li   // expects.
48*1a96fba6SXin Li   // NOLINTNEXTLINE(runtime/int)
49*1a96fba6SXin Li   return curl_easy_setopt(curl, option, static_cast<long>(value));
50*1a96fba6SXin Li }
51*1a96fba6SXin Li 
EasySetOptStr(CURL * curl,CURLoption option,const std::string & value)52*1a96fba6SXin Li CURLcode CurlApi::EasySetOptStr(CURL* curl,
53*1a96fba6SXin Li                                 CURLoption option,
54*1a96fba6SXin Li                                 const std::string& value) {
55*1a96fba6SXin Li   CHECK(VerifyOptionType(option, CURLOPTTYPE_OBJECTPOINT))
56*1a96fba6SXin Li       << "Only options that expect a STRING data type must be specified here";
57*1a96fba6SXin Li   return curl_easy_setopt(curl, option, value.c_str());
58*1a96fba6SXin Li }
59*1a96fba6SXin Li 
EasySetOptPtr(CURL * curl,CURLoption option,void * value)60*1a96fba6SXin Li CURLcode CurlApi::EasySetOptPtr(CURL* curl, CURLoption option, void* value) {
61*1a96fba6SXin Li   CHECK(VerifyOptionType(option, CURLOPTTYPE_OBJECTPOINT))
62*1a96fba6SXin Li       << "Only options that expect a pointer data type must be specified here";
63*1a96fba6SXin Li   return curl_easy_setopt(curl, option, value);
64*1a96fba6SXin Li }
65*1a96fba6SXin Li 
EasySetOptCallback(CURL * curl,CURLoption option,intptr_t address)66*1a96fba6SXin Li CURLcode CurlApi::EasySetOptCallback(CURL* curl,
67*1a96fba6SXin Li                                      CURLoption option,
68*1a96fba6SXin Li                                      intptr_t address) {
69*1a96fba6SXin Li   CHECK(VerifyOptionType(option, CURLOPTTYPE_FUNCTIONPOINT))
70*1a96fba6SXin Li       << "Only options that expect a function pointers must be specified here";
71*1a96fba6SXin Li   return curl_easy_setopt(curl, option, address);
72*1a96fba6SXin Li }
73*1a96fba6SXin Li 
EasySetOptOffT(CURL * curl,CURLoption option,curl_off_t value)74*1a96fba6SXin Li CURLcode CurlApi::EasySetOptOffT(CURL* curl,
75*1a96fba6SXin Li                                  CURLoption option,
76*1a96fba6SXin Li                                  curl_off_t value) {
77*1a96fba6SXin Li   CHECK(VerifyOptionType(option, CURLOPTTYPE_OFF_T))
78*1a96fba6SXin Li       << "Only options that expect a large data size must be specified here";
79*1a96fba6SXin Li   return curl_easy_setopt(curl, option, value);
80*1a96fba6SXin Li }
81*1a96fba6SXin Li 
EasyPerform(CURL * curl)82*1a96fba6SXin Li CURLcode CurlApi::EasyPerform(CURL* curl) {
83*1a96fba6SXin Li   return curl_easy_perform(curl);
84*1a96fba6SXin Li }
85*1a96fba6SXin Li 
EasyGetInfoInt(CURL * curl,CURLINFO info,int * value) const86*1a96fba6SXin Li CURLcode CurlApi::EasyGetInfoInt(CURL* curl, CURLINFO info, int* value) const {
87*1a96fba6SXin Li   CHECK_EQ(CURLINFO_LONG, info & CURLINFO_TYPEMASK) << "Wrong option type";
88*1a96fba6SXin Li   long data = 0;  // NOLINT(runtime/int) - curl expects a long here.
89*1a96fba6SXin Li   CURLcode code = curl_easy_getinfo(curl, info, &data);
90*1a96fba6SXin Li   if (code == CURLE_OK)
91*1a96fba6SXin Li     *value = static_cast<int>(data);
92*1a96fba6SXin Li   return code;
93*1a96fba6SXin Li }
94*1a96fba6SXin Li 
EasyGetInfoDbl(CURL * curl,CURLINFO info,double * value) const95*1a96fba6SXin Li CURLcode CurlApi::EasyGetInfoDbl(CURL* curl,
96*1a96fba6SXin Li                                  CURLINFO info,
97*1a96fba6SXin Li                                  double* value) const {
98*1a96fba6SXin Li   CHECK_EQ(CURLINFO_DOUBLE, info & CURLINFO_TYPEMASK) << "Wrong option type";
99*1a96fba6SXin Li   return curl_easy_getinfo(curl, info, value);
100*1a96fba6SXin Li }
101*1a96fba6SXin Li 
EasyGetInfoStr(CURL * curl,CURLINFO info,std::string * value) const102*1a96fba6SXin Li CURLcode CurlApi::EasyGetInfoStr(CURL* curl,
103*1a96fba6SXin Li                                  CURLINFO info,
104*1a96fba6SXin Li                                  std::string* value) const {
105*1a96fba6SXin Li   CHECK_EQ(CURLINFO_STRING, info & CURLINFO_TYPEMASK) << "Wrong option type";
106*1a96fba6SXin Li   char* data = nullptr;
107*1a96fba6SXin Li   CURLcode code = curl_easy_getinfo(curl, info, &data);
108*1a96fba6SXin Li   if (code == CURLE_OK)
109*1a96fba6SXin Li     *value = data;
110*1a96fba6SXin Li   return code;
111*1a96fba6SXin Li }
112*1a96fba6SXin Li 
EasyGetInfoPtr(CURL * curl,CURLINFO info,void ** value) const113*1a96fba6SXin Li CURLcode CurlApi::EasyGetInfoPtr(CURL* curl,
114*1a96fba6SXin Li                                  CURLINFO info,
115*1a96fba6SXin Li                                  void** value) const {
116*1a96fba6SXin Li   // CURL uses "string" type for generic pointer info. Go figure.
117*1a96fba6SXin Li   CHECK_EQ(CURLINFO_STRING, info & CURLINFO_TYPEMASK) << "Wrong option type";
118*1a96fba6SXin Li   return curl_easy_getinfo(curl, info, value);
119*1a96fba6SXin Li }
120*1a96fba6SXin Li 
EasyStrError(CURLcode code) const121*1a96fba6SXin Li std::string CurlApi::EasyStrError(CURLcode code) const {
122*1a96fba6SXin Li   return curl_easy_strerror(code);
123*1a96fba6SXin Li }
124*1a96fba6SXin Li 
MultiInit()125*1a96fba6SXin Li CURLM* CurlApi::MultiInit() {
126*1a96fba6SXin Li   return curl_multi_init();
127*1a96fba6SXin Li }
128*1a96fba6SXin Li 
MultiCleanup(CURLM * multi_handle)129*1a96fba6SXin Li CURLMcode CurlApi::MultiCleanup(CURLM* multi_handle) {
130*1a96fba6SXin Li   return curl_multi_cleanup(multi_handle);
131*1a96fba6SXin Li }
132*1a96fba6SXin Li 
MultiInfoRead(CURLM * multi_handle,int * msgs_in_queue)133*1a96fba6SXin Li CURLMsg* CurlApi::MultiInfoRead(CURLM* multi_handle, int* msgs_in_queue) {
134*1a96fba6SXin Li   return curl_multi_info_read(multi_handle, msgs_in_queue);
135*1a96fba6SXin Li }
136*1a96fba6SXin Li 
MultiAddHandle(CURLM * multi_handle,CURL * curl_handle)137*1a96fba6SXin Li CURLMcode CurlApi::MultiAddHandle(CURLM* multi_handle, CURL* curl_handle) {
138*1a96fba6SXin Li   return curl_multi_add_handle(multi_handle, curl_handle);
139*1a96fba6SXin Li }
140*1a96fba6SXin Li 
MultiRemoveHandle(CURLM * multi_handle,CURL * curl_handle)141*1a96fba6SXin Li CURLMcode CurlApi::MultiRemoveHandle(CURLM* multi_handle, CURL* curl_handle) {
142*1a96fba6SXin Li   return curl_multi_remove_handle(multi_handle, curl_handle);
143*1a96fba6SXin Li }
144*1a96fba6SXin Li 
MultiSetSocketCallback(CURLM * multi_handle,curl_socket_callback socket_callback,void * userp)145*1a96fba6SXin Li CURLMcode CurlApi::MultiSetSocketCallback(CURLM* multi_handle,
146*1a96fba6SXin Li                                           curl_socket_callback socket_callback,
147*1a96fba6SXin Li                                           void* userp) {
148*1a96fba6SXin Li   CURLMcode code =
149*1a96fba6SXin Li       curl_multi_setopt(multi_handle, CURLMOPT_SOCKETFUNCTION, socket_callback);
150*1a96fba6SXin Li   if (code != CURLM_OK)
151*1a96fba6SXin Li     return code;
152*1a96fba6SXin Li   return curl_multi_setopt(multi_handle, CURLMOPT_SOCKETDATA, userp);
153*1a96fba6SXin Li }
154*1a96fba6SXin Li 
MultiSetTimerCallback(CURLM * multi_handle,curl_multi_timer_callback timer_callback,void * userp)155*1a96fba6SXin Li CURLMcode CurlApi::MultiSetTimerCallback(
156*1a96fba6SXin Li     CURLM* multi_handle,
157*1a96fba6SXin Li     curl_multi_timer_callback timer_callback,
158*1a96fba6SXin Li     void* userp) {
159*1a96fba6SXin Li   CURLMcode code =
160*1a96fba6SXin Li       curl_multi_setopt(multi_handle, CURLMOPT_TIMERFUNCTION, timer_callback);
161*1a96fba6SXin Li   if (code != CURLM_OK)
162*1a96fba6SXin Li     return code;
163*1a96fba6SXin Li   return curl_multi_setopt(multi_handle, CURLMOPT_TIMERDATA, userp);
164*1a96fba6SXin Li }
165*1a96fba6SXin Li 
MultiAssign(CURLM * multi_handle,curl_socket_t sockfd,void * sockp)166*1a96fba6SXin Li CURLMcode CurlApi::MultiAssign(CURLM* multi_handle,
167*1a96fba6SXin Li                                curl_socket_t sockfd,
168*1a96fba6SXin Li                                void* sockp) {
169*1a96fba6SXin Li   return curl_multi_assign(multi_handle, sockfd, sockp);
170*1a96fba6SXin Li }
171*1a96fba6SXin Li 
MultiSocketAction(CURLM * multi_handle,curl_socket_t s,int ev_bitmask,int * running_handles)172*1a96fba6SXin Li CURLMcode CurlApi::MultiSocketAction(CURLM* multi_handle,
173*1a96fba6SXin Li                                      curl_socket_t s,
174*1a96fba6SXin Li                                      int ev_bitmask,
175*1a96fba6SXin Li                                      int* running_handles) {
176*1a96fba6SXin Li   return curl_multi_socket_action(multi_handle, s, ev_bitmask, running_handles);
177*1a96fba6SXin Li }
178*1a96fba6SXin Li 
MultiStrError(CURLMcode code) const179*1a96fba6SXin Li std::string CurlApi::MultiStrError(CURLMcode code) const {
180*1a96fba6SXin Li   return curl_multi_strerror(code);
181*1a96fba6SXin Li }
182*1a96fba6SXin Li 
MultiPerform(CURLM * multi_handle,int * running_handles)183*1a96fba6SXin Li CURLMcode CurlApi::MultiPerform(CURLM* multi_handle, int* running_handles) {
184*1a96fba6SXin Li   return curl_multi_perform(multi_handle, running_handles);
185*1a96fba6SXin Li }
186*1a96fba6SXin Li 
MultiWait(CURLM * multi_handle,curl_waitfd extra_fds[],unsigned int extra_nfds,int timeout_ms,int * numfds)187*1a96fba6SXin Li CURLMcode CurlApi::MultiWait(CURLM* multi_handle,
188*1a96fba6SXin Li                              curl_waitfd extra_fds[],
189*1a96fba6SXin Li                              unsigned int extra_nfds,
190*1a96fba6SXin Li                              int timeout_ms,
191*1a96fba6SXin Li                              int* numfds) {
192*1a96fba6SXin Li   return curl_multi_wait(multi_handle, extra_fds, extra_nfds, timeout_ms,
193*1a96fba6SXin Li                          numfds);
194*1a96fba6SXin Li }
195*1a96fba6SXin Li 
196*1a96fba6SXin Li }  // namespace http
197*1a96fba6SXin Li }  // namespace brillo
198