5e8aabc519cc3ff8eb476eceeef95e45aee32538
[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, equivalent to fetch "default" cache mode.
40     ReloadIgnoringCacheData, // reload, equivalent to fetch "reload"cache mode.
41     ReturnCacheDataElseLoad, // back/forward or encoding change - allow stale data, equivalent to fetch "force-cache" cache mode.
42     ReturnCacheDataDontLoad, // results of a post - allow stale data and only use cache, equivalent to fetch "only-if-cached" cache mode.
43     DoNotUseAnyCache, // Bypass the cache entirely, equivalent to fetch "no-store" cache mode.
44     RefreshAnyCacheData, // Serve cache data only if revalidated, equivalent to fetch "no-cache" mode.
45 };
46
47 enum HTTPBodyUpdatePolicy {
48     DoNotUpdateHTTPBody,
49     UpdateHTTPBody
50 };
51
52 class ResourceRequest;
53 class ResourceResponse;
54
55 // Do not use this type directly.  Use ResourceRequest instead.
56 class ResourceRequestBase {
57     WTF_MAKE_FAST_ALLOCATED;
58 public:
59     ResourceRequest isolatedCopy() const;
60     WEBCORE_EXPORT void setAsIsolatedCopy(const ResourceRequest&);
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     WEBCORE_EXPORT ResourceRequest redirectedRequest(const ResourceResponse&, bool shouldClearReferrerOnHTTPSToHTTPRedirect) const;
69
70     WEBCORE_EXPORT void removeCredentials();
71
72     WEBCORE_EXPORT ResourceRequestCachePolicy cachePolicy() const;
73     WEBCORE_EXPORT void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
74     
75     double timeoutInterval() const; // May return 0 when using platform default.
76     void setTimeoutInterval(double timeoutInterval);
77     
78     WEBCORE_EXPORT const URL& firstPartyForCookies() const;
79     WEBCORE_EXPORT void setFirstPartyForCookies(const URL&);
80     
81     WEBCORE_EXPORT const String& httpMethod() const;
82     WEBCORE_EXPORT void setHTTPMethod(const String& httpMethod);
83     
84     WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
85     WEBCORE_EXPORT void setHTTPHeaderFields(HTTPHeaderMap);
86
87     WEBCORE_EXPORT String httpHeaderField(const String& name) const;
88     WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
89     WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
90     WEBCORE_EXPORT void setHTTPHeaderField(HTTPHeaderName, const String& value);
91     WEBCORE_EXPORT void addHTTPHeaderField(HTTPHeaderName, const String& value);
92     WEBCORE_EXPORT void addHTTPHeaderField(const String& name, const String& value);
93     WEBCORE_EXPORT void addHTTPHeaderFieldIfNotPresent(HTTPHeaderName, const String&);
94
95     bool hasHTTPHeaderField(HTTPHeaderName) const;
96
97     // Instead of passing a string literal to any of these functions, just use a HTTPHeaderName instead.
98     template<size_t length> String httpHeaderField(const char (&)[length]) const = delete;
99     template<size_t length> void setHTTPHeaderField(const char (&)[length], const String&) = delete;
100     template<size_t length> void addHTTPHeaderField(const char (&)[length], const String&) = delete;
101
102     WEBCORE_EXPORT void clearHTTPAuthorization();
103
104     WEBCORE_EXPORT String httpContentType() const;
105     WEBCORE_EXPORT void setHTTPContentType(const String&);
106     WEBCORE_EXPORT void clearHTTPContentType();
107
108     bool hasHTTPHeader(HTTPHeaderName) const;
109
110     WEBCORE_EXPORT String httpReferrer() const;
111     bool hasHTTPReferrer() const;
112     WEBCORE_EXPORT void setHTTPReferrer(const String&);
113     WEBCORE_EXPORT void setExistingHTTPReferrerToOriginString();
114     WEBCORE_EXPORT void clearHTTPReferrer();
115
116     WEBCORE_EXPORT String httpOrigin() const;
117     bool hasHTTPOrigin() const;
118     void setHTTPOrigin(const String&);
119     WEBCORE_EXPORT void clearHTTPOrigin();
120
121     WEBCORE_EXPORT String httpUserAgent() const;
122     WEBCORE_EXPORT void setHTTPUserAgent(const String&);
123     void clearHTTPUserAgent();
124
125     String httpAccept() const;
126     void setHTTPAccept(const String&);
127     void clearHTTPAccept();
128
129     void clearHTTPAcceptEncoding();
130
131     const Vector<String>& responseContentDispositionEncodingFallbackArray() const { return m_responseContentDispositionEncodingFallbackArray; }
132     WEBCORE_EXPORT void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
133
134     WEBCORE_EXPORT FormData* httpBody() const;
135     WEBCORE_EXPORT void setHTTPBody(RefPtr<FormData>&&);
136
137     bool allowCookies() const;
138     void setAllowCookies(bool allowCookies);
139
140     WEBCORE_EXPORT ResourceLoadPriority priority() const;
141     WEBCORE_EXPORT void setPriority(ResourceLoadPriority);
142
143     WEBCORE_EXPORT static String partitionName(const String& domain);
144     const String& cachePartition() const { return m_cachePartition; }
145     WEBCORE_EXPORT void setCachePartition(const String&);
146     void setDomainForCachePartition(const String& domain) { setCachePartition(partitionName(domain)); }
147
148     WEBCORE_EXPORT bool isConditional() const;
149     WEBCORE_EXPORT void makeUnconditional();
150
151     // Whether this request should be hidden from the Inspector.
152     bool hiddenFromInspector() const { return m_hiddenFromInspector; }
153     void setHiddenFromInspector(bool hiddenFromInspector) { m_hiddenFromInspector = hiddenFromInspector; }
154
155     enum class Requester { Unspecified, Main, XHR, Fetch, Media };
156     Requester requester() const { return m_requester; }
157     void setRequester(Requester requester) { m_requester = requester; }
158
159     // Who initiated the request so the Inspector can associate it with a context. E.g. a Web Worker.
160     String initiatorIdentifier() const { return m_initiatorIdentifier; }
161     void setInitiatorIdentifier(const String& identifier) { m_initiatorIdentifier = identifier; }
162
163 #if !PLATFORM(COCOA)
164     bool encodingRequiresPlatformData() const { return true; }
165 #endif
166     template<class Encoder> void encodeWithoutPlatformData(Encoder&) const;
167     template<class Decoder> bool decodeWithoutPlatformData(Decoder&);
168
169     WEBCORE_EXPORT static double defaultTimeoutInterval(); // May return 0 when using platform default.
170     WEBCORE_EXPORT static void setDefaultTimeoutInterval(double);
171
172     WEBCORE_EXPORT static bool equal(const ResourceRequest&, const ResourceRequest&);
173
174 protected:
175     // Used when ResourceRequest is initialized from a platform representation of the request
176     ResourceRequestBase()
177         : m_platformRequestUpdated(true)
178         , m_platformRequestBodyUpdated(true)
179     {
180     }
181
182     ResourceRequestBase(const URL& url, ResourceRequestCachePolicy policy)
183         : m_url(url)
184         , m_timeoutInterval(s_defaultTimeoutInterval)
185         , m_httpMethod(ASCIILiteral("GET"))
186         , m_cachePolicy(policy)
187         , m_allowCookies(true)
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     template<class Encoder> void encodeBase(Encoder&) const;
197     template<class Decoder> bool decodeBase(Decoder&);
198
199     // The ResourceRequest subclass may "shadow" this method to compare platform specific fields
200     static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
201
202     URL m_url;
203     double m_timeoutInterval; // 0 is a magic value for platform default on platforms that have one.
204     URL m_firstPartyForCookies;
205     String m_httpMethod;
206     HTTPHeaderMap m_httpHeaderFields;
207     Vector<String> m_responseContentDispositionEncodingFallbackArray;
208     RefPtr<FormData> m_httpBody;
209     ResourceRequestCachePolicy m_cachePolicy { UseProtocolCachePolicy };
210     bool m_allowCookies { false };
211     mutable bool m_resourceRequestUpdated { false };
212     mutable bool m_platformRequestUpdated { false };
213     mutable bool m_resourceRequestBodyUpdated { false };
214     mutable bool m_platformRequestBodyUpdated { false };
215     bool m_hiddenFromInspector { false };
216     ResourceLoadPriority m_priority { ResourceLoadPriority::Low };
217     Requester m_requester { Requester::Unspecified };
218     String m_initiatorIdentifier;
219     String m_cachePartition { emptyString() };
220
221 private:
222     const ResourceRequest& asResourceRequest() const;
223
224     WEBCORE_EXPORT static double s_defaultTimeoutInterval;
225 };
226
227 bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
228
229 inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::equal(a, b); }
230 inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
231
232 WEBCORE_EXPORT unsigned initializeMaximumHTTPConnectionCountPerHost();
233 #if PLATFORM(IOS)
234 WEBCORE_EXPORT void initializeHTTPConnectionSettingsOnStartup();
235 #endif
236
237 template<class Encoder>
238 ALWAYS_INLINE void ResourceRequestBase::encodeBase(Encoder& encoder) const
239 {
240     encoder << m_url;
241     encoder << m_timeoutInterval;
242     encoder << m_firstPartyForCookies.string();
243     encoder << m_httpMethod;
244     encoder << m_httpHeaderFields;
245     encoder << m_responseContentDispositionEncodingFallbackArray;
246     encoder.encodeEnum(m_cachePolicy);
247     encoder << m_allowCookies;
248     encoder.encodeEnum(m_priority);
249     encoder.encodeEnum(m_requester);
250 }
251
252 template<class Decoder>
253 ALWAYS_INLINE bool ResourceRequestBase::decodeBase(Decoder& decoder)
254 {
255     if (!decoder.decode(m_url))
256         return false;
257
258     if (!decoder.decode(m_timeoutInterval))
259         return false;
260
261     String firstPartyForCookies;
262     if (!decoder.decode(firstPartyForCookies))
263         return false;
264     m_firstPartyForCookies = URL(ParsedURLString, firstPartyForCookies);
265
266     if (!decoder.decode(m_httpMethod))
267         return false;
268
269     if (!decoder.decode(m_httpHeaderFields))
270         return false;
271
272     if (!decoder.decode(m_responseContentDispositionEncodingFallbackArray))
273         return false;
274
275     ResourceRequestCachePolicy cachePolicy;
276     if (!decoder.decodeEnum(cachePolicy))
277         return false;
278     m_cachePolicy = cachePolicy;
279
280     bool allowCookies;
281     if (!decoder.decode(allowCookies))
282         return false;
283     m_allowCookies = allowCookies;
284
285     ResourceLoadPriority priority;
286     if (!decoder.decodeEnum(priority))
287         return false;
288     m_priority = priority;
289
290     if (!decoder.decodeEnum(m_requester))
291         return false;
292
293     return true;
294 }
295
296 template<class Encoder>
297 void ResourceRequestBase::encodeWithoutPlatformData(Encoder& encoder) const
298 {
299     ASSERT(!m_httpBody);
300     ASSERT(!m_platformRequestUpdated);
301     encodeBase(encoder);
302 }
303
304 template<class Decoder>
305 bool ResourceRequestBase::decodeWithoutPlatformData(Decoder& decoder)
306 {
307     return decodeBase(decoder);
308 }
309
310 } // namespace WebCore
311
312 #endif // ResourceRequestBase_h