HTTPHeaderMap should not derive from HashMap
[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 PassOwnPtr<ResourceRequest> adopt(PassOwnPtr<CrossThreadResourceRequestData>);
58
59         // Gets a copy of the data suitable for passing to another thread.
60         PassOwnPtr<CrossThreadResourceRequestData> copyData() const;
61
62         bool isNull() const;
63         bool isEmpty() const;
64
65         const URL& url() const;
66         void setURL(const URL& url);
67
68         void removeCredentials();
69
70         ResourceRequestCachePolicy cachePolicy() const;
71         void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
72         
73         double timeoutInterval() const; // May return 0 when using platform default.
74         void setTimeoutInterval(double timeoutInterval);
75         
76         const URL& firstPartyForCookies() const;
77         void setFirstPartyForCookies(const URL& firstPartyForCookies);
78         
79         const String& httpMethod() const;
80         void setHTTPMethod(const String& httpMethod);
81         
82         const HTTPHeaderMap& httpHeaderFields() const;
83         String httpHeaderField(const AtomicString& name) const;
84         String httpHeaderField(const char* name) const;
85         void setHTTPHeaderField(const AtomicString& name, const String& value);
86         void setHTTPHeaderField(const char* name, const String& value);
87         void addHTTPHeaderField(const AtomicString& name, const String& value);
88         void addHTTPHeaderFields(const HTTPHeaderMap& headerFields);
89         
90         void clearHTTPAuthorization();
91
92         String httpContentType() const { return httpHeaderField("Content-Type");  }
93         void setHTTPContentType(const String& httpContentType) { setHTTPHeaderField("Content-Type", httpContentType); }
94         void clearHTTPContentType();
95
96         String httpReferrer() const { return httpHeaderField("Referer"); }
97         void setHTTPReferrer(const String& httpReferrer) { setHTTPHeaderField("Referer", httpReferrer); }
98         void clearHTTPReferrer();
99         
100         String httpOrigin() const { return httpHeaderField("Origin"); }
101         void setHTTPOrigin(const String& httpOrigin) { setHTTPHeaderField("Origin", httpOrigin); }
102         void clearHTTPOrigin();
103
104         String httpUserAgent() const { return httpHeaderField("User-Agent"); }
105         void setHTTPUserAgent(const String& httpUserAgent) { setHTTPHeaderField("User-Agent", httpUserAgent); }
106         void clearHTTPUserAgent();
107
108         String httpAccept() const { return httpHeaderField("Accept"); }
109         void setHTTPAccept(const String& httpAccept) { setHTTPHeaderField("Accept", httpAccept); }
110         void clearHTTPAccept();
111
112         const Vector<String>& responseContentDispositionEncodingFallbackArray() const { return m_responseContentDispositionEncodingFallbackArray; }
113         void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
114
115         FormData* httpBody() const;
116         void setHTTPBody(PassRefPtr<FormData> httpBody);
117         
118         bool allowCookies() const;
119         void setAllowCookies(bool allowCookies);
120
121         ResourceLoadPriority priority() const;
122         void setPriority(ResourceLoadPriority);
123
124         bool isConditional() const;
125         void makeUnconditional();
126
127         // Whether the associated ResourceHandleClient needs to be notified of
128         // upload progress made for that resource.
129         bool reportUploadProgress() const { return m_reportUploadProgress; }
130         void setReportUploadProgress(bool reportUploadProgress) { m_reportUploadProgress = reportUploadProgress; }
131
132         // Whether the timing information should be collected for the request.
133         bool reportLoadTiming() const { return m_reportLoadTiming; }
134         void setReportLoadTiming(bool reportLoadTiming) { m_reportLoadTiming = reportLoadTiming; }
135
136         // Whether actual headers being sent/received should be collected and reported for the request.
137         bool reportRawHeaders() const { return m_reportRawHeaders; }
138         void setReportRawHeaders(bool reportRawHeaders) { m_reportRawHeaders = reportRawHeaders; }
139
140 #if ENABLE(INSPECTOR)
141         // Whether this request should be hidden from the Inspector.
142         bool hiddenFromInspector() const { return m_hiddenFromInspector; }
143         void setHiddenFromInspector(bool hiddenFromInspector) { m_hiddenFromInspector = hiddenFromInspector; }
144 #endif
145
146         static double defaultTimeoutInterval(); // May return 0 when using platform default.
147         static void setDefaultTimeoutInterval(double);
148
149 #if PLATFORM(IOS)
150         static bool defaultAllowCookies();
151         static void setDefaultAllowCookies(bool);
152 #endif
153
154         static bool compare(const ResourceRequest&, const ResourceRequest&);
155
156     protected:
157         // Used when ResourceRequest is initialized from a platform representation of the request
158         ResourceRequestBase()
159             : m_resourceRequestUpdated(false)
160             , m_platformRequestUpdated(true)
161             , m_resourceRequestBodyUpdated(false)
162             , m_platformRequestBodyUpdated(true)
163             , m_reportUploadProgress(false)
164             , m_reportLoadTiming(false)
165             , m_reportRawHeaders(false)
166 #if ENABLE(INSPECTOR)
167             , m_hiddenFromInspector(false)
168 #endif
169             , m_priority(ResourceLoadPriorityLow)
170         {
171         }
172
173         ResourceRequestBase(const URL& url, ResourceRequestCachePolicy policy)
174             : m_url(url)
175             , m_timeoutInterval(s_defaultTimeoutInterval)
176             , m_httpMethod(ASCIILiteral("GET"))
177             , m_cachePolicy(policy)
178 #if !PLATFORM(IOS)
179             , m_allowCookies(true)
180 #else
181             , m_allowCookies(ResourceRequestBase::defaultAllowCookies())
182 #endif
183             , m_resourceRequestUpdated(true)
184             , m_platformRequestUpdated(false)
185             , m_resourceRequestBodyUpdated(true)
186             , m_platformRequestBodyUpdated(false)
187             , m_reportUploadProgress(false)
188             , m_reportLoadTiming(false)
189             , m_reportRawHeaders(false)
190 #if ENABLE(INSPECTOR)
191             , m_hiddenFromInspector(false)
192 #endif
193             , m_priority(ResourceLoadPriorityLow)
194         {
195         }
196
197         void updatePlatformRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
198         void updateResourceRequest(HTTPBodyUpdatePolicy = DoNotUpdateHTTPBody) const;
199
200         // The ResourceRequest subclass may "shadow" this method to compare platform specific fields
201         static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
202
203         URL m_url;
204         double m_timeoutInterval; // 0 is a magic value for platform default on platforms that have one.
205         URL m_firstPartyForCookies;
206         String m_httpMethod;
207         HTTPHeaderMap m_httpHeaderFields;
208         Vector<String> m_responseContentDispositionEncodingFallbackArray;
209         RefPtr<FormData> m_httpBody;
210         ResourceRequestCachePolicy m_cachePolicy : 3;
211         bool m_allowCookies : 1;
212         mutable bool m_resourceRequestUpdated : 1;
213         mutable bool m_platformRequestUpdated : 1;
214         mutable bool m_resourceRequestBodyUpdated : 1;
215         mutable bool m_platformRequestBodyUpdated : 1;
216         bool m_reportUploadProgress : 1;
217         bool m_reportLoadTiming : 1;
218         bool m_reportRawHeaders : 1;
219 #if ENABLE(INSPECTOR)
220         bool m_hiddenFromInspector : 1;
221 #endif
222         ResourceLoadPriority m_priority : 4;
223
224     private:
225         const ResourceRequest& asResourceRequest() const;
226
227         static double s_defaultTimeoutInterval;
228 #if PLATFORM(IOS)
229         static bool s_defaultAllowCookies;
230 #endif
231     };
232
233     bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
234
235     inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::compare(a, b); }
236     inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
237
238     struct CrossThreadResourceRequestDataBase {
239         WTF_MAKE_NONCOPYABLE(CrossThreadResourceRequestDataBase); WTF_MAKE_FAST_ALLOCATED;
240     public:
241         CrossThreadResourceRequestDataBase() { }
242         URL m_url;
243
244         ResourceRequestCachePolicy m_cachePolicy;
245         double m_timeoutInterval;
246         URL m_firstPartyForCookies;
247
248         String m_httpMethod;
249         std::unique_ptr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
250         Vector<String> m_responseContentDispositionEncodingFallbackArray;
251         RefPtr<FormData> m_httpBody;
252         bool m_allowCookies;
253         ResourceLoadPriority m_priority;
254     };
255     
256     unsigned initializeMaximumHTTPConnectionCountPerHost();
257 #if PLATFORM(IOS)
258     void initializeHTTPConnectionSettingsOnStartup();
259 #endif
260 } // namespace WebCore
261
262 #endif // ResourceRequestBase_h