[Curl] Refactor and improve methods in the CurlHandle
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlContext.h
1 /*
2  * Copyright (C) 2013 Apple Inc.  All rights reserved.
3  * Copyright (C) 2017 Sony Interactive Entertainment Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #pragma once
28
29 #include "CookieJarCurl.h"
30 #include "CurlSSLHandle.h"
31 #include "URL.h"
32
33 #include <wtf/Lock.h>
34 #include <wtf/NeverDestroyed.h>
35 #include <wtf/Noncopyable.h>
36 #include <wtf/Threading.h>
37
38 #if OS(WINDOWS)
39 #include <windows.h>
40 #include <winsock2.h>
41 #endif
42
43 #include <curl/curl.h>
44
45 namespace WebCore {
46
47 enum class CurlProxyType {
48     Invalid = -1,
49     HTTP = CURLPROXY_HTTP,
50     Socks4 = CURLPROXY_SOCKS4,
51     Socks4A = CURLPROXY_SOCKS4A,
52     Socks5 = CURLPROXY_SOCKS5,
53     Socks5Hostname = CURLPROXY_SOCKS5_HOSTNAME
54 };
55
56 // CurlGlobal --------------------------------------------
57 // to make the initialization of libcurl happen before other initialization of CurlContext
58
59 class CurlGlobal {
60 protected:
61     CurlGlobal()
62     {
63         curl_global_init(CURL_GLOBAL_ALL);
64     }
65     
66     virtual ~CurlGlobal()
67     {
68         curl_global_cleanup();
69     }
70 };
71
72 // CurlShareHandle --------------------------------------------
73
74 class CurlShareHandle {
75     WTF_MAKE_NONCOPYABLE(CurlShareHandle);
76
77 public:
78     CurlShareHandle();
79     ~CurlShareHandle();
80
81     CURLSH* handle() const { return m_shareHandle; }
82
83 private:
84     static void lockCallback(CURL*, curl_lock_data, curl_lock_access, void*);
85     static void unlockCallback(CURL*, curl_lock_data, void*);
86     static Lock* mutexFor(curl_lock_data);
87
88     CURLSH* m_shareHandle { nullptr };
89 };
90
91 // CurlContext --------------------------------------------
92
93 class CurlContext : public CurlGlobal {
94     WTF_MAKE_NONCOPYABLE(CurlContext);
95
96 public:
97     struct ProxyInfo {
98         String host;
99         unsigned long port;
100         CurlProxyType type { CurlProxyType::Invalid };
101         String username;
102         String password;
103
104         const String url() const;
105     };
106
107     static CurlContext& singleton()
108     {
109         static CurlContext shared;
110         return shared;
111     }
112
113     virtual ~CurlContext();
114
115     const CurlShareHandle& shareHandle() { return m_shareHandle; }
116
117     // Cookie
118     const char* getCookieJarFileName() const { return m_cookieJarFileName.data(); }
119     void setCookieJarFileName(const char* cookieJarFileName) { m_cookieJarFileName = CString(cookieJarFileName); }
120     CookieJarCurl& cookieJar() { return *m_cookieJar; }
121
122     // Proxy
123     const ProxyInfo& proxyInfo() const { return m_proxy; }
124     void setProxyInfo(const ProxyInfo& info) { m_proxy = info;  }
125     void setProxyInfo(const String& host = emptyString(), unsigned long port = 0, CurlProxyType = CurlProxyType::HTTP, const String& username = emptyString(), const String& password = emptyString());
126
127     // SSL
128     CurlSSLHandle& sslHandle() { return m_sslHandle; }
129
130 #ifndef NDEBUG
131     FILE* getLogFile() const { return m_logFile; }
132     bool isVerbose() const { return m_verbose; }
133 #endif
134
135 private:
136     ProxyInfo m_proxy;
137     CString m_cookieJarFileName;
138     CurlShareHandle m_shareHandle;
139     std::unique_ptr<CookieJarCurl> m_cookieJar;
140     CurlSSLHandle m_sslHandle;
141
142     CurlContext();
143     void initCookieSession();
144
145
146 #ifndef NDEBUG
147     FILE* m_logFile { nullptr };
148     bool m_verbose { false };
149 #endif
150 };
151
152 // CurlMultiHandle --------------------------------------------
153
154 class CurlMultiHandle {
155     WTF_MAKE_NONCOPYABLE(CurlMultiHandle);
156
157 public:
158     CurlMultiHandle();
159     ~CurlMultiHandle();
160
161     CURLMcode addHandle(CURL*);
162     CURLMcode removeHandle(CURL*);
163
164     CURLMcode getFdSet(fd_set&, fd_set&, fd_set&, int&);
165     CURLMcode perform(int&);
166     CURLMsg* readInfo(int&);
167
168 private:
169     CURLM* m_multiHandle { nullptr };
170 };
171
172 // CurlSList -------------------------------------------------
173
174 class CurlSList {
175 public:
176     CurlSList() { }
177     ~CurlSList() { clear(); }
178
179     operator struct curl_slist** () { return &m_list; }
180
181     const struct curl_slist* head() const { return m_list; }
182     bool isEmpty() const { return !m_list; }
183     void clear()
184     {
185         if (m_list) {
186             curl_slist_free_all(m_list);
187             m_list = nullptr;
188         }
189     }
190
191     void append(const char* str) { m_list = curl_slist_append(m_list, str); }
192     void append(const String& str) { append(str.latin1().data()); }
193
194 private:
195     struct curl_slist* m_list { nullptr };
196 };
197
198 // CurlHandle -------------------------------------------------
199
200 class HTTPHeaderMap;
201 class NetworkLoadMetrics;
202
203 class CurlHandle {
204     WTF_MAKE_NONCOPYABLE(CurlHandle);
205
206 public:
207     enum class VerifyPeer {
208         Disable = 0L,
209         Enable = 1L
210     };
211
212     enum class VerifyHost {
213         LooseNameCheck = 0,
214         StrictNameCheck = 2
215     };
216
217     CurlHandle();
218     virtual ~CurlHandle();
219
220     CURL* handle() const { return m_handle; }
221
222     void initialize();
223
224     CURLcode perform();
225     CURLcode pause(int);
226
227     CURLcode errorCode() const { return m_errorCode; }
228     void setErrorCode(CURLcode errorCode) { m_errorCode = errorCode; }
229
230     static const String errorDescription(CURLcode);
231
232     void enableShareHandle();
233
234     void setUrl(const URL&);
235
236     void appendRequestHeaders(const HTTPHeaderMap&);
237     void appendRequestHeader(const String& name, const String& value);
238     void appendRequestHeader(const String& name);
239     void removeRequestHeader(const String& name);
240
241     void enableHttpGetRequest();
242     void enableHttpHeadRequest();
243     void enableHttpPostRequest();
244     void setPostFields(const char*, long);
245     void setPostFieldLarge(curl_off_t);
246     void enableHttpPutRequest();
247     void setInFileSizeLarge(curl_off_t);
248     void setHttpCustomRequest(const String&);
249
250     void enableAcceptEncoding();
251     void enableAllowedProtocols();
252
253     void enableFollowLocation();
254     void enableAutoReferer();
255
256     void enableHttpAuthentication(long);
257     void setHttpAuthUserPass(const String&, const String&);
258
259     void setCACertPath(const char*);
260     void setSslVerifyPeer(VerifyPeer);
261     void setSslVerifyHost(VerifyHost);
262     void setSslCert(const char*);
263     void setSslCertType(const char*);
264     void setSslKeyPassword(const char*);
265
266     void enableCookieJarIfExists();
267     void setCookieList(const char*);
268     void fetchCookieList(CurlSList &cookies) const;
269
270     void enableProxyIfExists();
271
272     void enableTimeout();
273
274     // Callback function
275     void setHeaderCallbackFunction(curl_write_callback, void*);
276     void setWriteCallbackFunction(curl_write_callback, void*);
277     void setReadCallbackFunction(curl_read_callback, void*);
278     void setSslCtxCallbackFunction(curl_ssl_ctx_callback, void*);
279
280     // Status
281     URL getEffectiveURL();
282     std::optional<uint16_t> getPrimaryPort();
283     std::optional<long> getResponseCode();
284     std::optional<long long> getContentLength();
285     std::optional<long> getHttpAuthAvail();
286     std::optional<NetworkLoadMetrics> getNetworkLoadMetrics();
287
288     static long long maxCurlOffT();
289
290 #ifndef NDEBUG
291     void enableVerboseIfUsed();
292     void enableStdErrIfUsed();
293 #endif
294
295 private:
296     void enableRequestHeaders();
297     static int expectedSizeOfCurlOffT();
298
299     CURL* m_handle { nullptr };
300     char m_errorBuffer[CURL_ERROR_SIZE] { };
301     CURLcode m_errorCode;
302
303     CurlSList m_requestHeaders;
304 };
305
306 }