Move ResourceLoadScheduler to WebKit1
[WebKit-https.git] / Source / WebCore / platform / network / ResourceRequestBase.h
1 /*
2  * Copyright (C) 2003, 2006 Apple Inc.  All rights reserved.
3  * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
4  * Copyright (C) 2009, 2012 Google Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #ifndef ResourceRequestBase_h
29 #define ResourceRequestBase_h
30
31 #include "FormData.h"
32 #include "HTTPHeaderMap.h"
33 #include "URL.h"
34 #include "ResourceLoadPriority.h"
35
36 namespace WebCore {
37
38     enum ResourceRequestCachePolicy {
39         UseProtocolCachePolicy, // normal load
40         ReloadIgnoringCacheData, // reload
41         ReturnCacheDataElseLoad, // back/forward or encoding change - allow stale data
42         ReturnCacheDataDontLoad  // results of a post - allow stale data and only use cache
43     };
44
45     enum HTTPBodyUpdatePolicy {
46         DoNotUpdateHTTPBody,
47         UpdateHTTPBody
48     };
49
50     class ResourceRequest;
51     struct CrossThreadResourceRequestData;
52
53     // Do not use this type directly.  Use ResourceRequest instead.
54     class ResourceRequestBase {
55         WTF_MAKE_FAST_ALLOCATED;
56     public:
57         static std::unique_ptr<ResourceRequest> adopt(std::unique_ptr<CrossThreadResourceRequestData>);
58
59         // Gets a copy of the data suitable for passing to another thread.
60         std::unique_ptr<CrossThreadResourceRequestData> copyData() const;
61
62         WEBCORE_EXPORT bool isNull() const;
63         WEBCORE_EXPORT bool isEmpty() const;
64
65         WEBCORE_EXPORT const URL& url() const;
66         WEBCORE_EXPORT void setURL(const URL& url);
67
68         void removeCredentials();
69
70         WEBCORE_EXPORT ResourceRequestCachePolicy cachePolicy() const;
71         WEBCORE_EXPORT void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
72         
73         double timeoutInterval() const; // May return 0 when using platform default.
74         void setTimeoutInterval(double timeoutInterval);
75         
76         WEBCORE_EXPORT const URL& firstPartyForCookies() const;
77         void setFirstPartyForCookies(const URL& firstPartyForCookies);
78         
79         WEBCORE_EXPORT const String& httpMethod() const;
80         WEBCORE_EXPORT void setHTTPMethod(const String& httpMethod);
81         
82         WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
83         WEBCORE_EXPORT void setHTTPHeaderFields(HTTPHeaderMap);
84
85         WEBCORE_EXPORT String httpHeaderField(const String& name) const;
86         WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
87         WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
88         WEBCORE_EXPORT void setHTTPHeaderField(HTTPHeaderName, const String& value);
89         void addHTTPHeaderField(const String& name, const String& value);
90
91         // Instead of passing a string literal to any of these functions, just use a HTTPHeaderName instead.
92         template<size_t length> String httpHeaderField(const char (&)[length]) const = delete;
93         template<size_t length> void setHTTPHeaderField(const char (&)[length], const String&) = delete;
94         template<size_t length> void addHTTPHeaderField(const char (&)[length], const String&) = delete;
95
96         void clearHTTPAuthorization();
97
98         WEBCORE_EXPORT String httpContentType() const;
99         WEBCORE_EXPORT void setHTTPContentType(const String&);
100         void clearHTTPContentType();
101
102         String httpReferrer() const;
103         WEBCORE_EXPORT void setHTTPReferrer(const String&);
104         void clearHTTPReferrer();
105         
106         String httpOrigin() const;
107         void setHTTPOrigin(const String&);
108         void clearHTTPOrigin();
109
110         String httpUserAgent() const;
111         void setHTTPUserAgent(const String&);
112         void clearHTTPUserAgent();
113
114         String httpAccept() const;
115         void setHTTPAccept(const String&);
116         void clearHTTPAccept();
117
118         const Vector<String>& responseContentDispositionEncodingFallbackArray() const { return m_responseContentDispositionEncodingFallbackArray; }
119         WEBCORE_EXPORT void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
120
121         WEBCORE_EXPORT FormData* httpBody() const;
122         WEBCORE_EXPORT void setHTTPBody(PassRefPtr<FormData> httpBody);
123         
124         bool allowCookies() const;
125         void setAllowCookies(bool allowCookies);
126
127         WEBCORE_EXPORT ResourceLoadPriority priority() const;
128         WEBCORE_EXPORT void setPriority(ResourceLoadPriority);
129
130         WEBCORE_EXPORT bool isConditional() const;
131         void makeUnconditional();
132
133         // Whether the associated ResourceHandleClient needs to be notified of
134         // upload progress made for that resource.
135         bool reportUploadProgress() const { return m_reportUploadProgress; }
136         void setReportUploadProgress(bool reportUploadProgress) { m_reportUploadProgress = reportUploadProgress; }
137
138         // Whether the timing information should be collected for the request.
139         bool reportLoadTiming() const { return m_reportLoadTiming; }
140         void setReportLoadTiming(bool reportLoadTiming) { m_reportLoadTiming = reportLoadTiming; }
141
142         // Whether actual headers being sent/received should be collected and reported for the request.
143         bool reportRawHeaders() const { return m_reportRawHeaders; }
144         void setReportRawHeaders(bool reportRawHeaders) { m_reportRawHeaders = reportRawHeaders; }
145
146         // Whether this request should be hidden from the Inspector.
147         bool hiddenFromInspector() const { return m_hiddenFromInspector; }
148         void setHiddenFromInspector(bool hiddenFromInspector) { m_hiddenFromInspector = hiddenFromInspector; }
149
150         enum class Requester { Unspecified, Main, XHR };
151         Requester requester() const { return m_requester; }
152         void setRequester(Requester requester) { m_requester = requester; }
153
154 #if !PLATFORM(COCOA)
155         bool encodingRequiresPlatformData() const { return true; }
156 #endif
157         template<class Encoder> void encodeWithoutPlatformData(Encoder&) const;
158         template<class Decoder> bool decodeWithoutPlatformData(Decoder&);
159
160         WEBCORE_EXPORT static double defaultTimeoutInterval(); // May return 0 when using platform default.
161         WEBCORE_EXPORT static void setDefaultTimeoutInterval(double);
162
163 #if PLATFORM(IOS)
164         WEBCORE_EXPORT static bool defaultAllowCookies();
165         WEBCORE_EXPORT static void setDefaultAllowCookies(bool);
166 #endif
167
168         static bool compare(const ResourceRequest&, const ResourceRequest&);
169
170     protected:
171         // Used when ResourceRequest is initialized from a platform representation of the request
172         ResourceRequestBase()
173             : m_platformRequestUpdated(true)
174             , m_platformRequestBodyUpdated(true)
175         {
176         }
177
178         ResourceRequestBase(const URL& url, ResourceRequestCachePolicy policy)
179             : m_url(url)
180             , m_timeoutInterval(s_defaultTimeoutInterval)
181             , m_httpMethod(ASCIILiteral("GET"))
182             , m_cachePolicy(policy)
183 #if !PLATFORM(IOS)
184             , m_allowCookies(true)
185 #else
186             , m_allowCookies(ResourceRequestBase::defaultAllowCookies())
187 #endif
188             , m_resourceRequestUpdated(true)
189             , m_resourceRequestBodyUpdated(true)
190         {
191         }
192
193         void updatePlatformRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
194         void updateResourceRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
195
196         // The ResourceRequest subclass may "shadow" this method to compare platform specific fields
197         static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
198
199         URL m_url;
200         double m_timeoutInterval; // 0 is a magic value for platform default on platforms that have one.
201         URL m_firstPartyForCookies;
202         String m_httpMethod;
203         HTTPHeaderMap m_httpHeaderFields;
204         Vector<String> m_responseContentDispositionEncodingFallbackArray;
205         RefPtr<FormData> m_httpBody;
206         ResourceRequestCachePolicy m_cachePolicy { UseProtocolCachePolicy };
207         bool m_allowCookies { false };
208         mutable bool m_resourceRequestUpdated { false };
209         mutable bool m_platformRequestUpdated { false };
210         mutable bool m_resourceRequestBodyUpdated { false };
211         mutable bool m_platformRequestBodyUpdated { false };
212         bool m_reportUploadProgress { false };
213         bool m_reportLoadTiming { false };
214         bool m_reportRawHeaders { false };
215         bool m_hiddenFromInspector { false };
216         ResourceLoadPriority m_priority { ResourceLoadPriority::Low };
217         Requester m_requester { Requester::Unspecified };
218
219     private:
220         const ResourceRequest& asResourceRequest() const;
221
222         WEBCORE_EXPORT static double s_defaultTimeoutInterval;
223 #if PLATFORM(IOS)
224         static bool s_defaultAllowCookies;
225 #endif
226     };
227
228     bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
229
230     inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::compare(a, b); }
231     inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
232
233     struct CrossThreadResourceRequestDataBase {
234         URL url;
235         ResourceRequestCachePolicy cachePolicy;
236         double timeoutInterval;
237         URL firstPartyForCookies;
238         String httpMethod;
239         std::unique_ptr<CrossThreadHTTPHeaderMapData> httpHeaders;
240         Vector<String> responseContentDispositionEncodingFallbackArray;
241         RefPtr<FormData> httpBody;
242         bool allowCookies;
243         ResourceLoadPriority priority;
244         ResourceRequestBase::Requester requester;
245     };
246     
247     WEBCORE_EXPORT unsigned initializeMaximumHTTPConnectionCountPerHost();
248 #if PLATFORM(IOS)
249     WEBCORE_EXPORT void initializeHTTPConnectionSettingsOnStartup();
250 #endif
251
252 template<class Encoder>
253 void ResourceRequestBase::encodeWithoutPlatformData(Encoder& encoder) const
254 {
255     ASSERT(!m_httpBody);
256     ASSERT(!m_platformRequestUpdated);
257     encoder << m_url.string();
258     encoder << m_timeoutInterval;
259     encoder << m_firstPartyForCookies.string();
260     encoder << m_httpMethod;
261     encoder << m_httpHeaderFields;
262     encoder << m_responseContentDispositionEncodingFallbackArray;
263     encoder.encodeEnum(m_cachePolicy);
264     encoder << m_allowCookies;
265     encoder.encodeEnum(m_priority);
266     encoder.encodeEnum(m_requester);
267 }
268
269 template<class Decoder>
270 bool ResourceRequestBase::decodeWithoutPlatformData(Decoder& decoder)
271 {
272     String url;
273     if (!decoder.decode(url))
274         return false;
275     m_url = URL(ParsedURLString, url);
276
277     if (!decoder.decode(m_timeoutInterval))
278         return false;
279
280     String firstPartyForCookies;
281     if (!decoder.decode(firstPartyForCookies))
282         return false;
283     m_firstPartyForCookies = URL(ParsedURLString, firstPartyForCookies);
284
285     if (!decoder.decode(m_httpMethod))
286         return false;
287
288     if (!decoder.decode(m_httpHeaderFields))
289         return false;
290
291     if (!decoder.decode(m_responseContentDispositionEncodingFallbackArray))
292         return false;
293
294     ResourceRequestCachePolicy cachePolicy;
295     if (!decoder.decodeEnum(cachePolicy))
296         return false;
297     m_cachePolicy = cachePolicy;
298
299     bool allowCookies;
300     if (!decoder.decode(allowCookies))
301         return false;
302     m_allowCookies = allowCookies;
303
304     ResourceLoadPriority priority;
305     if (!decoder.decodeEnum(priority))
306         return false;
307     m_priority = priority;
308
309     if (!decoder.decodeEnum(m_requester))
310         return false;
311
312     return true;
313 }
314
315 } // namespace WebCore
316
317 #endif // ResourceRequestBase_h