[Curl] Extract multipart handling from ResourceHandle to CurlRequest.
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlRequest.h
1 /*
2  * Copyright (C) 2018 Sony Interactive Entertainment Inc.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  * 
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "CurlFormDataStream.h"
29 #include "CurlMultipartHandle.h"
30 #include "CurlMultipartHandleClient.h"
31 #include "CurlRequestSchedulerClient.h"
32 #include "CurlResponse.h"
33 #include "CurlSSLVerifier.h"
34 #include "FileSystem.h"
35 #include "NetworkLoadMetrics.h"
36 #include "ResourceRequest.h"
37 #include <wtf/Noncopyable.h>
38
39 namespace WebCore {
40
41 class CurlRequestClient;
42 class ResourceError;
43 class SharedBuffer;
44
45 class CurlRequest : public ThreadSafeRefCounted<CurlRequest>, public CurlRequestSchedulerClient, public CurlMultipartHandleClient {
46     WTF_MAKE_NONCOPYABLE(CurlRequest);
47
48 public:
49     enum class ShouldSuspend : bool {
50         No = false,
51         Yes = true
52     };
53
54     enum class EnableMultipart : bool {
55         No = false,
56         Yes = true
57     };
58
59     static Ref<CurlRequest> create(const ResourceRequest& request, CurlRequestClient* client, ShouldSuspend shouldSuspend = ShouldSuspend::No, EnableMultipart enableMultipart = EnableMultipart::No)
60     {
61         return adoptRef(*new CurlRequest(request, client, shouldSuspend == ShouldSuspend::Yes, enableMultipart == EnableMultipart::Yes));
62     }
63
64     virtual ~CurlRequest() = default;
65
66     void setClient(CurlRequestClient* client) { m_client = client;  }
67     void setUserPass(const String&, const String&);
68
69     void start(bool isSyncRequest = false);
70     void cancel();
71     void suspend();
72     void resume();
73
74     bool isSyncRequest() const { return m_isSyncRequest; }
75     bool isCompleted() const { return !m_curlHandle; }
76     bool isCancelled() const { return m_cancelled; }
77     bool isCompletedOrCancelled() const { return isCompleted() || isCancelled(); }
78
79
80     // Processing for DidReceiveResponse
81     void completeDidReceiveResponse();
82
83     // Download
84     void enableDownloadToFile();
85     const String& getDownloadedFilePath();
86
87     NetworkLoadMetrics getNetworkLoadMetrics() { return m_networkLoadMetrics.isolatedCopy(); }
88
89 private:
90     enum class Action {
91         None,
92         ReceiveData,
93         StartTransfer,
94         FinishTransfer
95     };
96
97     CurlRequest(const ResourceRequest&, CurlRequestClient*, bool shouldSuspend, bool enableMultipart);
98
99     void retain() override { ref(); }
100     void release() override { deref(); }
101     CURL* handle() override { return m_curlHandle ? m_curlHandle->handle() : nullptr; }
102
103     void startWithJobManager();
104
105     void callClient(WTF::Function<void(CurlRequestClient*)>);
106
107     // Transfer processing of Request body, Response header/body
108     // Called by worker thread in case of async, main thread in case of sync.
109     CURL* setupTransfer() override;
110     CURLcode willSetupSslCtx(void*);
111     size_t willSendData(char*, size_t, size_t);
112     size_t didReceiveHeader(String&&);
113     size_t didReceiveData(Ref<SharedBuffer>&&);
114     void didReceiveHeaderFromMultipart(const Vector<String>&) override;
115     void didReceiveDataFromMultipart(Ref<SharedBuffer>&&) override;
116     void didCompleteTransfer(CURLcode) override;
117     void didCancelTransfer() override;
118     void finalizeTransfer();
119
120     // For POST and PUT method 
121     void setupPOST(ResourceRequest&);
122     void setupPUT(ResourceRequest&);
123     void setupSendData(bool forPutMethod);
124
125     // Processing for DidReceiveResponse
126     bool needToInvokeDidReceiveResponse() const { return !m_didNotifyResponse || !m_didReturnFromNotify; }
127     bool needToInvokeDidCancelTransfer() const { return m_didNotifyResponse && !m_didReturnFromNotify && m_actionAfterInvoke == Action::FinishTransfer; }
128     void invokeDidReceiveResponseForFile(URL&);
129     void invokeDidReceiveResponse(const CurlResponse&, Action);
130     void setRequestPaused(bool);
131     void setCallbackPaused(bool);
132     void pausedStatusChanged();
133     bool isPaused() const { return m_isPausedOfRequest || m_isPausedOfCallback; };
134
135     // Download
136     void writeDataToDownloadFileIfEnabled(const SharedBuffer&);
137     void closeDownloadFile();
138     void cleanupDownloadFile();
139
140     // Callback functions for curl
141     static CURLcode willSetupSslCtxCallback(CURL*, void*, void*);
142     static size_t willSendDataCallback(char*, size_t, size_t, void*);
143     static size_t didReceiveHeaderCallback(char*, size_t, size_t, void*);
144     static size_t didReceiveDataCallback(char*, size_t, size_t, void*);
145
146
147     std::atomic<CurlRequestClient*> m_client { };
148     bool m_isSyncRequest { false };
149     bool m_cancelled { false };
150
151     // Used by worker thread in case of async, and main thread in case of sync.
152     ResourceRequest m_request;
153     String m_user;
154     String m_password;
155     bool m_shouldSuspend { false };
156     bool m_enableMultipart { false };
157
158     std::unique_ptr<CurlHandle> m_curlHandle;
159     CurlFormDataStream m_formDataStream;
160     CurlSSLVerifier m_sslVerifier;
161     std::unique_ptr<CurlMultipartHandle> m_multipartHandle;
162
163     CurlResponse m_response;
164     bool m_didReceiveResponse { false };
165     bool m_didNotifyResponse { false };
166     bool m_didReturnFromNotify { false };
167     Action m_actionAfterInvoke { Action::None };
168     CURLcode m_finishedResultCode { CURLE_OK };
169
170     bool m_isPausedOfRequest { false };
171     bool m_isPausedOfCallback { false };
172
173     Lock m_downloadMutex;
174     bool m_isEnabledDownloadToFile { false };
175     String m_downloadFilePath;
176     FileSystem::PlatformFileHandle m_downloadFileHandle { FileSystem::invalidPlatformFileHandle };
177
178     NetworkLoadMetrics m_networkLoadMetrics;
179 };
180
181 } // namespace WebCore