Modernize how many platform/network classes do isolatedCopy().
[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     void setHTTPOrigin(const String&);
106     WEBCORE_EXPORT void clearHTTPOrigin();
107
108     WEBCORE_EXPORT String httpUserAgent() const;
109     WEBCORE_EXPORT void setHTTPUserAgent(const String&);
110     void clearHTTPUserAgent();
111
112     String httpAccept() const;
113     void setHTTPAccept(const String&);
114     void clearHTTPAccept();
115
116     void clearHTTPAcceptEncoding();
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(RefPtr<FormData>&&);
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     WEBCORE_EXPORT 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, Media };
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 WEBCORE_EXPORT unsigned initializeMaximumHTTPConnectionCountPerHost();
234 #if PLATFORM(IOS)
235 WEBCORE_EXPORT void initializeHTTPConnectionSettingsOnStartup();
236 #endif
237
238 template<class Encoder>
239 void ResourceRequestBase::encodeWithoutPlatformData(Encoder& encoder) const
240 {
241     ASSERT(!m_httpBody);
242     ASSERT(!m_platformRequestUpdated);
243     encoder << m_url;
244     encoder << m_timeoutInterval;
245     encoder << m_firstPartyForCookies.string();
246     encoder << m_httpMethod;
247     encoder << m_httpHeaderFields;
248     encoder << m_responseContentDispositionEncodingFallbackArray;
249     encoder.encodeEnum(m_cachePolicy);
250     encoder << m_allowCookies;
251     encoder.encodeEnum(m_priority);
252     encoder.encodeEnum(m_requester);
253 }
254
255 template<class Decoder>
256 bool ResourceRequestBase::decodeWithoutPlatformData(Decoder& decoder)
257 {
258     if (!decoder.decode(m_url))
259         return false;
260
261     if (!decoder.decode(m_timeoutInterval))
262         return false;
263
264     String firstPartyForCookies;
265     if (!decoder.decode(firstPartyForCookies))
266         return false;
267     m_firstPartyForCookies = URL(ParsedURLString, firstPartyForCookies);
268
269     if (!decoder.decode(m_httpMethod))
270         return false;
271
272     if (!decoder.decode(m_httpHeaderFields))
273         return false;
274
275     if (!decoder.decode(m_responseContentDispositionEncodingFallbackArray))
276         return false;
277
278     ResourceRequestCachePolicy cachePolicy;
279     if (!decoder.decodeEnum(cachePolicy))
280         return false;
281     m_cachePolicy = cachePolicy;
282
283     bool allowCookies;
284     if (!decoder.decode(allowCookies))
285         return false;
286     m_allowCookies = allowCookies;
287
288     ResourceLoadPriority priority;
289     if (!decoder.decodeEnum(priority))
290         return false;
291     m_priority = priority;
292
293     if (!decoder.decodeEnum(m_requester))
294         return false;
295
296     return true;
297 }
298
299 } // namespace WebCore
300
301 #endif // ResourceRequestBase_h