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