Add support for service worker generated redirections
[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     void addHTTPHeaderField(HTTPHeaderName, const String& value);
92     void addHTTPHeaderField(const String& name, const String& value);
93     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 clearHTTPReferrer();
114
115     String httpOrigin() const;
116     bool hasHTTPOrigin() const;
117     void setHTTPOrigin(const String&);
118     WEBCORE_EXPORT void clearHTTPOrigin();
119
120     WEBCORE_EXPORT String httpUserAgent() const;
121     WEBCORE_EXPORT void setHTTPUserAgent(const String&);
122     void clearHTTPUserAgent();
123
124     String httpAccept() const;
125     void setHTTPAccept(const String&);
126     void clearHTTPAccept();
127
128     void clearHTTPAcceptEncoding();
129
130     const Vector<String>& responseContentDispositionEncodingFallbackArray() const { return m_responseContentDispositionEncodingFallbackArray; }
131     WEBCORE_EXPORT void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
132
133     WEBCORE_EXPORT FormData* httpBody() const;
134     WEBCORE_EXPORT void setHTTPBody(RefPtr<FormData>&&);
135
136     bool allowCookies() const;
137     void setAllowCookies(bool allowCookies);
138
139     WEBCORE_EXPORT ResourceLoadPriority priority() const;
140     WEBCORE_EXPORT void setPriority(ResourceLoadPriority);
141
142     WEBCORE_EXPORT static String partitionName(const String& domain);
143     const String& cachePartition() const { return m_cachePartition; }
144     WEBCORE_EXPORT void setCachePartition(const String&);
145     void setDomainForCachePartition(const String& domain) { setCachePartition(partitionName(domain)); }
146
147     WEBCORE_EXPORT bool isConditional() const;
148     WEBCORE_EXPORT void makeUnconditional();
149
150     // Whether this request should be hidden from the Inspector.
151     bool hiddenFromInspector() const { return m_hiddenFromInspector; }
152     void setHiddenFromInspector(bool hiddenFromInspector) { m_hiddenFromInspector = hiddenFromInspector; }
153
154     enum class Requester { Unspecified, Main, XHR, Fetch, Media };
155     Requester requester() const { return m_requester; }
156     void setRequester(Requester requester) { m_requester = requester; }
157
158     // Who initiated the request so the Inspector can associate it with a context. E.g. a Web Worker.
159     String initiatorIdentifier() const { return m_initiatorIdentifier; }
160     void setInitiatorIdentifier(const String& identifier) { m_initiatorIdentifier = identifier; }
161
162 #if !PLATFORM(COCOA)
163     bool encodingRequiresPlatformData() const { return true; }
164 #endif
165     template<class Encoder> void encodeWithoutPlatformData(Encoder&) const;
166     template<class Decoder> bool decodeWithoutPlatformData(Decoder&);
167
168     WEBCORE_EXPORT static double defaultTimeoutInterval(); // May return 0 when using platform default.
169     WEBCORE_EXPORT static void setDefaultTimeoutInterval(double);
170
171 #if PLATFORM(IOS)
172     WEBCORE_EXPORT static bool defaultAllowCookies();
173     WEBCORE_EXPORT static void setDefaultAllowCookies(bool);
174 #endif
175
176     WEBCORE_EXPORT static bool equal(const ResourceRequest&, const ResourceRequest&);
177
178 protected:
179     // Used when ResourceRequest is initialized from a platform representation of the request
180     ResourceRequestBase()
181         : m_platformRequestUpdated(true)
182         , m_platformRequestBodyUpdated(true)
183     {
184     }
185
186     ResourceRequestBase(const URL& url, ResourceRequestCachePolicy policy)
187         : m_url(url)
188         , m_timeoutInterval(s_defaultTimeoutInterval)
189         , m_httpMethod(ASCIILiteral("GET"))
190         , m_cachePolicy(policy)
191 #if !PLATFORM(IOS)
192         , m_allowCookies(true)
193 #else
194         , m_allowCookies(ResourceRequestBase::defaultAllowCookies())
195 #endif
196         , m_resourceRequestUpdated(true)
197         , m_resourceRequestBodyUpdated(true)
198     {
199     }
200
201     void updatePlatformRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
202     void updateResourceRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
203
204     template<class Encoder> void encodeBase(Encoder&) const;
205     template<class Decoder> bool decodeBase(Decoder&);
206
207     // The ResourceRequest subclass may "shadow" this method to compare platform specific fields
208     static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
209
210     URL m_url;
211     double m_timeoutInterval; // 0 is a magic value for platform default on platforms that have one.
212     URL m_firstPartyForCookies;
213     String m_httpMethod;
214     HTTPHeaderMap m_httpHeaderFields;
215     Vector<String> m_responseContentDispositionEncodingFallbackArray;
216     RefPtr<FormData> m_httpBody;
217     ResourceRequestCachePolicy m_cachePolicy { UseProtocolCachePolicy };
218     bool m_allowCookies { false };
219     mutable bool m_resourceRequestUpdated { false };
220     mutable bool m_platformRequestUpdated { false };
221     mutable bool m_resourceRequestBodyUpdated { false };
222     mutable bool m_platformRequestBodyUpdated { false };
223     bool m_hiddenFromInspector { false };
224     ResourceLoadPriority m_priority { ResourceLoadPriority::Low };
225     Requester m_requester { Requester::Unspecified };
226     String m_initiatorIdentifier;
227     String m_cachePartition { emptyString() };
228
229 private:
230     const ResourceRequest& asResourceRequest() const;
231
232     WEBCORE_EXPORT static double s_defaultTimeoutInterval;
233 #if PLATFORM(IOS)
234     static bool s_defaultAllowCookies;
235 #endif
236 };
237
238 bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
239
240 inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::equal(a, b); }
241 inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
242
243 WEBCORE_EXPORT unsigned initializeMaximumHTTPConnectionCountPerHost();
244 #if PLATFORM(IOS)
245 WEBCORE_EXPORT void initializeHTTPConnectionSettingsOnStartup();
246 #endif
247
248 template<class Encoder>
249 ALWAYS_INLINE void ResourceRequestBase::encodeBase(Encoder& encoder) const
250 {
251     encoder << m_url;
252     encoder << m_timeoutInterval;
253     encoder << m_firstPartyForCookies.string();
254     encoder << m_httpMethod;
255     encoder << m_httpHeaderFields;
256     encoder << m_responseContentDispositionEncodingFallbackArray;
257     encoder.encodeEnum(m_cachePolicy);
258     encoder << m_allowCookies;
259     encoder.encodeEnum(m_priority);
260     encoder.encodeEnum(m_requester);
261 }
262
263 template<class Decoder>
264 ALWAYS_INLINE bool ResourceRequestBase::decodeBase(Decoder& decoder)
265 {
266     if (!decoder.decode(m_url))
267         return false;
268
269     if (!decoder.decode(m_timeoutInterval))
270         return false;
271
272     String firstPartyForCookies;
273     if (!decoder.decode(firstPartyForCookies))
274         return false;
275     m_firstPartyForCookies = URL(ParsedURLString, firstPartyForCookies);
276
277     if (!decoder.decode(m_httpMethod))
278         return false;
279
280     if (!decoder.decode(m_httpHeaderFields))
281         return false;
282
283     if (!decoder.decode(m_responseContentDispositionEncodingFallbackArray))
284         return false;
285
286     ResourceRequestCachePolicy cachePolicy;
287     if (!decoder.decodeEnum(cachePolicy))
288         return false;
289     m_cachePolicy = cachePolicy;
290
291     bool allowCookies;
292     if (!decoder.decode(allowCookies))
293         return false;
294     m_allowCookies = allowCookies;
295
296     ResourceLoadPriority priority;
297     if (!decoder.decodeEnum(priority))
298         return false;
299     m_priority = priority;
300
301     if (!decoder.decodeEnum(m_requester))
302         return false;
303
304     return true;
305 }
306
307 template<class Encoder>
308 void ResourceRequestBase::encodeWithoutPlatformData(Encoder& encoder) const
309 {
310     ASSERT(!m_httpBody);
311     ASSERT(!m_platformRequestUpdated);
312     encodeBase(encoder);
313 }
314
315 template<class Decoder>
316 bool ResourceRequestBase::decodeWithoutPlatformData(Decoder& decoder)
317 {
318     return decodeBase(decoder);
319 }
320
321 } // namespace WebCore
322
323 #endif // ResourceRequestBase_h