Add event support for link preload.
[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
52 // Do not use this type directly.  Use ResourceRequest instead.
53 class ResourceRequestBase {
54     WTF_MAKE_FAST_ALLOCATED;
55 public:
56     ResourceRequest isolatedCopy() const;
57     WEBCORE_EXPORT void setAsIsolatedCopy(const ResourceRequest&);
58
59     WEBCORE_EXPORT bool isNull() const;
60     WEBCORE_EXPORT bool isEmpty() const;
61
62     WEBCORE_EXPORT const URL& url() const;
63     WEBCORE_EXPORT void setURL(const URL& url);
64
65     WEBCORE_EXPORT void removeCredentials();
66
67     WEBCORE_EXPORT ResourceRequestCachePolicy cachePolicy() const;
68     WEBCORE_EXPORT void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
69     
70     double timeoutInterval() const; // May return 0 when using platform default.
71     void setTimeoutInterval(double timeoutInterval);
72     
73     WEBCORE_EXPORT const URL& firstPartyForCookies() const;
74     WEBCORE_EXPORT void setFirstPartyForCookies(const URL&);
75     
76     WEBCORE_EXPORT const String& httpMethod() const;
77     WEBCORE_EXPORT void setHTTPMethod(const String& httpMethod);
78     
79     WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
80     WEBCORE_EXPORT void setHTTPHeaderFields(HTTPHeaderMap);
81
82     WEBCORE_EXPORT String httpHeaderField(const String& name) const;
83     WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
84     WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
85     WEBCORE_EXPORT void setHTTPHeaderField(HTTPHeaderName, const String& value);
86     void addHTTPHeaderField(HTTPHeaderName, const String& value);
87     void addHTTPHeaderField(const String& name, const String& value);
88
89     // Instead of passing a string literal to any of these functions, just use a HTTPHeaderName instead.
90     template<size_t length> String httpHeaderField(const char (&)[length]) const = delete;
91     template<size_t length> void setHTTPHeaderField(const char (&)[length], const String&) = delete;
92     template<size_t length> void addHTTPHeaderField(const char (&)[length], const String&) = delete;
93
94     WEBCORE_EXPORT void clearHTTPAuthorization();
95
96     WEBCORE_EXPORT String httpContentType() const;
97     WEBCORE_EXPORT void setHTTPContentType(const String&);
98     void clearHTTPContentType();
99
100     WEBCORE_EXPORT String httpReferrer() const;
101     WEBCORE_EXPORT void setHTTPReferrer(const String&);
102     WEBCORE_EXPORT void clearHTTPReferrer();
103
104     String httpOrigin() const;
105     bool hasHTTPOrigin() const;
106     void setHTTPOrigin(const String&);
107     WEBCORE_EXPORT void clearHTTPOrigin();
108
109     WEBCORE_EXPORT String httpUserAgent() const;
110     WEBCORE_EXPORT void setHTTPUserAgent(const String&);
111     void clearHTTPUserAgent();
112
113     String httpAccept() const;
114     void setHTTPAccept(const String&);
115     void clearHTTPAccept();
116
117     void clearHTTPAcceptEncoding();
118
119     const Vector<String>& responseContentDispositionEncodingFallbackArray() const { return m_responseContentDispositionEncodingFallbackArray; }
120     WEBCORE_EXPORT void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
121
122     WEBCORE_EXPORT FormData* httpBody() const;
123     WEBCORE_EXPORT void setHTTPBody(RefPtr<FormData>&&);
124
125     bool allowCookies() const;
126     void setAllowCookies(bool allowCookies);
127
128     WEBCORE_EXPORT ResourceLoadPriority priority() const;
129     WEBCORE_EXPORT void setPriority(ResourceLoadPriority);
130
131     WEBCORE_EXPORT bool isConditional() const;
132     WEBCORE_EXPORT void makeUnconditional();
133
134     // Whether the associated ResourceHandleClient needs to be notified of
135     // upload progress made for that resource.
136     bool reportUploadProgress() const { return m_reportUploadProgress; }
137     void setReportUploadProgress(bool reportUploadProgress) { m_reportUploadProgress = reportUploadProgress; }
138
139     // Whether the timing information should be collected for the request.
140     bool reportLoadTiming() const { return m_reportLoadTiming; }
141     void setReportLoadTiming(bool reportLoadTiming) { m_reportLoadTiming = reportLoadTiming; }
142
143     // Whether actual headers being sent/received should be collected and reported for the request.
144     bool reportRawHeaders() const { return m_reportRawHeaders; }
145     void setReportRawHeaders(bool reportRawHeaders) { m_reportRawHeaders = reportRawHeaders; }
146
147     // Whether this request should be hidden from the Inspector.
148     bool hiddenFromInspector() const { return m_hiddenFromInspector; }
149     void setHiddenFromInspector(bool hiddenFromInspector) { m_hiddenFromInspector = hiddenFromInspector; }
150
151     // Whether this request should impact request counting and delay window.onload.
152     bool ignoreForRequestCount() const { return m_ignoreForRequestCount; }
153     void setIgnoreForRequestCount(bool ignoreForRequestCount) { m_ignoreForRequestCount = ignoreForRequestCount; }
154
155     enum class Requester { Unspecified, Main, XHR, Media };
156     Requester requester() const { return m_requester; }
157     void setRequester(Requester requester) { m_requester = requester; }
158
159 #if !PLATFORM(COCOA)
160     bool encodingRequiresPlatformData() const { return true; }
161 #endif
162     template<class Encoder> void encodeWithoutPlatformData(Encoder&) const;
163     template<class Decoder> bool decodeWithoutPlatformData(Decoder&);
164
165     WEBCORE_EXPORT static double defaultTimeoutInterval(); // May return 0 when using platform default.
166     WEBCORE_EXPORT static void setDefaultTimeoutInterval(double);
167
168 #if PLATFORM(IOS)
169     WEBCORE_EXPORT static bool defaultAllowCookies();
170     WEBCORE_EXPORT static void setDefaultAllowCookies(bool);
171 #endif
172
173     static bool compare(const ResourceRequest&, const ResourceRequest&);
174
175 protected:
176     // Used when ResourceRequest is initialized from a platform representation of the request
177     ResourceRequestBase()
178         : m_platformRequestUpdated(true)
179         , m_platformRequestBodyUpdated(true)
180     {
181     }
182
183     ResourceRequestBase(const URL& url, ResourceRequestCachePolicy policy)
184         : m_url(url)
185         , m_timeoutInterval(s_defaultTimeoutInterval)
186         , m_httpMethod(ASCIILiteral("GET"))
187         , m_cachePolicy(policy)
188 #if !PLATFORM(IOS)
189         , m_allowCookies(true)
190 #else
191         , m_allowCookies(ResourceRequestBase::defaultAllowCookies())
192 #endif
193         , m_resourceRequestUpdated(true)
194         , m_resourceRequestBodyUpdated(true)
195     {
196     }
197
198     void updatePlatformRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
199     void updateResourceRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
200
201     // The ResourceRequest subclass may "shadow" this method to compare platform specific fields
202     static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
203
204     URL m_url;
205     double m_timeoutInterval; // 0 is a magic value for platform default on platforms that have one.
206     URL m_firstPartyForCookies;
207     String m_httpMethod;
208     HTTPHeaderMap m_httpHeaderFields;
209     Vector<String> m_responseContentDispositionEncodingFallbackArray;
210     RefPtr<FormData> m_httpBody;
211     ResourceRequestCachePolicy m_cachePolicy { UseProtocolCachePolicy };
212     bool m_allowCookies { false };
213     mutable bool m_resourceRequestUpdated { false };
214     mutable bool m_platformRequestUpdated { false };
215     mutable bool m_resourceRequestBodyUpdated { false };
216     mutable bool m_platformRequestBodyUpdated { false };
217     bool m_reportUploadProgress { false };
218     bool m_reportLoadTiming { false };
219     bool m_reportRawHeaders { false };
220     bool m_hiddenFromInspector { false };
221     bool m_ignoreForRequestCount { false };
222     ResourceLoadPriority m_priority { ResourceLoadPriority::Low };
223     Requester m_requester { Requester::Unspecified };
224
225 private:
226     const ResourceRequest& asResourceRequest() const;
227
228     WEBCORE_EXPORT static double s_defaultTimeoutInterval;
229 #if PLATFORM(IOS)
230     static bool s_defaultAllowCookies;
231 #endif
232 };
233
234 bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
235
236 inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::compare(a, b); }
237 inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
238
239 WEBCORE_EXPORT unsigned initializeMaximumHTTPConnectionCountPerHost();
240 #if PLATFORM(IOS)
241 WEBCORE_EXPORT void initializeHTTPConnectionSettingsOnStartup();
242 #endif
243
244 template<class Encoder>
245 void ResourceRequestBase::encodeWithoutPlatformData(Encoder& encoder) const
246 {
247     ASSERT(!m_httpBody);
248     ASSERT(!m_platformRequestUpdated);
249     encoder << m_url;
250     encoder << m_timeoutInterval;
251     encoder << m_firstPartyForCookies.string();
252     encoder << m_httpMethod;
253     encoder << m_httpHeaderFields;
254     encoder << m_responseContentDispositionEncodingFallbackArray;
255     encoder.encodeEnum(m_cachePolicy);
256     encoder << m_allowCookies;
257     encoder.encodeEnum(m_priority);
258     encoder.encodeEnum(m_requester);
259 }
260
261 template<class Decoder>
262 bool ResourceRequestBase::decodeWithoutPlatformData(Decoder& decoder)
263 {
264     if (!decoder.decode(m_url))
265         return false;
266
267     if (!decoder.decode(m_timeoutInterval))
268         return false;
269
270     String firstPartyForCookies;
271     if (!decoder.decode(firstPartyForCookies))
272         return false;
273     m_firstPartyForCookies = URL(ParsedURLString, firstPartyForCookies);
274
275     if (!decoder.decode(m_httpMethod))
276         return false;
277
278     if (!decoder.decode(m_httpHeaderFields))
279         return false;
280
281     if (!decoder.decode(m_responseContentDispositionEncodingFallbackArray))
282         return false;
283
284     ResourceRequestCachePolicy cachePolicy;
285     if (!decoder.decodeEnum(cachePolicy))
286         return false;
287     m_cachePolicy = cachePolicy;
288
289     bool allowCookies;
290     if (!decoder.decode(allowCookies))
291         return false;
292     m_allowCookies = allowCookies;
293
294     ResourceLoadPriority priority;
295     if (!decoder.decodeEnum(priority))
296         return false;
297     m_priority = priority;
298
299     if (!decoder.decodeEnum(m_requester))
300         return false;
301
302     return true;
303 }
304
305 } // namespace WebCore
306
307 #endif // ResourceRequestBase_h