ea34fae616f3d5140bebd7dc63a962496c79ca59
[WebKit-https.git] / Source / WebCore / platform / network / curl / CurlRequest.h
1 /*
2  * Copyright (C) 2017 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 "CurlRequestSchedulerClient.h"
30 #include "CurlResponse.h"
31 #include "CurlSSLVerifier.h"
32 #include "FileSystem.h"
33 #include "NetworkLoadMetrics.h"
34 #include "ResourceRequest.h"
35 #include <wtf/Noncopyable.h>
36
37 namespace WebCore {
38
39 class CurlRequestClient;
40 class ResourceError;
41 class SharedBuffer;
42
43 class CurlRequest : public ThreadSafeRefCounted<CurlRequest>, public CurlRequestSchedulerClient {
44     WTF_MAKE_NONCOPYABLE(CurlRequest);
45
46 public:
47     static Ref<CurlRequest> create(const ResourceRequest& request, CurlRequestClient* client, bool shouldSuspend = false)
48     {
49         return adoptRef(*new CurlRequest(request, client, shouldSuspend));
50     }
51
52     virtual ~CurlRequest() = default;
53
54     void setClient(CurlRequestClient* client) { m_client = client;  }
55     void setUserPass(const String&, const String&);
56
57     void start(bool isSyncRequest = false);
58     void cancel();
59     void suspend();
60     void resume();
61
62     bool isSyncRequest() const { return m_isSyncRequest; }
63     bool isCompleted() const { return !m_curlHandle; }
64     bool isCancelled() const { return m_cancelled; }
65     bool isCompletedOrCancelled() const { return isCompleted() || isCancelled(); }
66
67
68     // Processing for DidReceiveResponse
69     void completeDidReceiveResponse();
70
71     // Download
72     void enableDownloadToFile();
73     const String& getDownloadedFilePath();
74
75     NetworkLoadMetrics getNetworkLoadMetrics() { return m_networkLoadMetrics.isolatedCopy(); }
76
77 private:
78     enum class Action {
79         None,
80         ReceiveData,
81         StartTransfer,
82         FinishTransfer
83     };
84
85     CurlRequest(const ResourceRequest&, CurlRequestClient*, bool shouldSuspend);
86
87     void retain() override { ref(); }
88     void release() override { deref(); }
89     CURL* handle() override { return m_curlHandle ? m_curlHandle->handle() : nullptr; }
90
91     void startWithJobManager();
92
93     void callClient(WTF::Function<void(CurlRequestClient*)>);
94
95     // Transfer processing of Request body, Response header/body
96     // Called by worker thread in case of async, main thread in case of sync.
97     CURL* setupTransfer() override;
98     CURLcode willSetupSslCtx(void*);
99     size_t willSendData(char*, size_t, size_t);
100     size_t didReceiveHeader(String&&);
101     size_t didReceiveData(Ref<SharedBuffer>&&);
102     void didCompleteTransfer(CURLcode) override;
103     void didCancelTransfer() override;
104     void finalizeTransfer();
105
106     // For POST and PUT method 
107     void setupPOST(ResourceRequest&);
108     void setupPUT(ResourceRequest&);
109     void setupSendData(bool forPutMethod);
110
111     // Processing for DidReceiveResponse
112     bool needToInvokeDidReceiveResponse() const { return !m_didNotifyResponse || !m_didReturnFromNotify; }
113     bool needToInvokeDidCancelTransfer() const { return m_didNotifyResponse && !m_didReturnFromNotify && m_actionAfterInvoke == Action::FinishTransfer; }
114     void invokeDidReceiveResponseForFile(URL&);
115     void invokeDidReceiveResponse(Action);
116     void setRequestPaused(bool);
117     void setCallbackPaused(bool);
118     void pausedStatusChanged();
119     bool isPaused() const { return m_isPausedOfRequest || m_isPausedOfCallback; };
120
121     // Download
122     void writeDataToDownloadFileIfEnabled(const SharedBuffer&);
123     void closeDownloadFile();
124     void cleanupDownloadFile();
125
126     // Callback functions for curl
127     static CURLcode willSetupSslCtxCallback(CURL*, void*, void*);
128     static size_t willSendDataCallback(char*, size_t, size_t, void*);
129     static size_t didReceiveHeaderCallback(char*, size_t, size_t, void*);
130     static size_t didReceiveDataCallback(char*, size_t, size_t, void*);
131
132
133     std::atomic<CurlRequestClient*> m_client { };
134     bool m_isSyncRequest { false };
135     bool m_cancelled { false };
136
137     // Used by worker thread in case of async, and main thread in case of sync.
138     ResourceRequest m_request;
139     String m_user;
140     String m_password;
141     bool m_shouldSuspend { false };
142
143     std::unique_ptr<CurlHandle> m_curlHandle;
144     CurlFormDataStream m_formDataStream;
145     CurlSSLVerifier m_sslVerifier;
146
147     CurlResponse m_response;
148     bool m_didReceiveResponse { false };
149     bool m_didNotifyResponse { false };
150     bool m_didReturnFromNotify { false };
151     Action m_actionAfterInvoke { Action::None };
152     CURLcode m_finishedResultCode { CURLE_OK };
153
154     bool m_isPausedOfRequest { false };
155     bool m_isPausedOfCallback { false };
156
157     Lock m_downloadMutex;
158     bool m_isEnabledDownloadToFile { false };
159     String m_downloadFilePath;
160     FileSystem::PlatformFileHandle m_downloadFileHandle { FileSystem::invalidPlatformFileHandle };
161
162     NetworkLoadMetrics m_networkLoadMetrics;
163 };
164
165 } // namespace WebCore