Reviewed by Adam Roben.
[WebKit-https.git] / Source / WebCore / platform / network / ResourceRequestBase.h
1 /*
2  * Copyright (C) 2003, 2006 Apple Computer, Inc.  All rights reserved.
3  * Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
4  * Copyright (C) 2009 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 COMPUTER, 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 COMPUTER, 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 "KURL.h"
34 #include "ResourceLoadPriority.h"
35
36 #include <wtf/OwnPtr.h>
37
38 namespace WebCore {
39
40     enum ResourceRequestCachePolicy {
41         UseProtocolCachePolicy, // normal load
42         ReloadIgnoringCacheData, // reload
43         ReturnCacheDataElseLoad, // back/forward or encoding change - allow stale data
44         ReturnCacheDataDontLoad, // results of a post - allow stale data and only use cache
45     };
46
47     class ResourceRequest;
48     struct CrossThreadResourceRequestData;
49
50     // Do not use this type directly.  Use ResourceRequest instead.
51     class ResourceRequestBase {
52         WTF_MAKE_FAST_ALLOCATED;
53     public:
54         // The type of this ResourceRequest, based on how the resource will be used.
55         enum TargetType {
56             TargetIsMainFrame,
57             TargetIsSubframe,
58             TargetIsSubresource,  // Resource is a generic subresource.  (Generally a specific type should be specified)
59             TargetIsStyleSheet,
60             TargetIsScript,
61             TargetIsFontResource,
62             TargetIsImage,
63             TargetIsObject,
64             TargetIsMedia,
65             TargetIsWorker,
66             TargetIsSharedWorker,
67             TargetIsPrefetch,
68         };
69
70         static PassOwnPtr<ResourceRequest> adopt(PassOwnPtr<CrossThreadResourceRequestData>);
71
72         // Gets a copy of the data suitable for passing to another thread.
73         PassOwnPtr<CrossThreadResourceRequestData> copyData() const;
74
75         bool isNull() const;
76         bool isEmpty() const;
77
78         const KURL& url() const;
79         void setURL(const KURL& url);
80
81         void removeCredentials();
82
83         ResourceRequestCachePolicy cachePolicy() const;
84         void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
85         
86         double timeoutInterval() const; // May return 0 when using platform default.
87         void setTimeoutInterval(double timeoutInterval);
88         
89         const KURL& firstPartyForCookies() const;
90         void setFirstPartyForCookies(const KURL& firstPartyForCookies);
91         
92         const String& httpMethod() const;
93         void setHTTPMethod(const String& httpMethod);
94         
95         const HTTPHeaderMap& httpHeaderFields() const;
96         String httpHeaderField(const AtomicString& name) const;
97         String httpHeaderField(const char* name) const;
98         void setHTTPHeaderField(const AtomicString& name, const String& value);
99         void setHTTPHeaderField(const char* name, const String& value);
100         void addHTTPHeaderField(const AtomicString& name, const String& value);
101         void addHTTPHeaderFields(const HTTPHeaderMap& headerFields);
102         
103         void clearHTTPAuthorization();
104
105         String httpContentType() const { return httpHeaderField("Content-Type");  }
106         void setHTTPContentType(const String& httpContentType) { setHTTPHeaderField("Content-Type", httpContentType); }
107         
108         String httpReferrer() const { return httpHeaderField("Referer"); }
109         void setHTTPReferrer(const String& httpReferrer) { setHTTPHeaderField("Referer", httpReferrer); }
110         void clearHTTPReferrer();
111         
112         String httpOrigin() const { return httpHeaderField("Origin"); }
113         void setHTTPOrigin(const String& httpOrigin) { setHTTPHeaderField("Origin", httpOrigin); }
114         void clearHTTPOrigin();
115
116         String httpUserAgent() const { return httpHeaderField("User-Agent"); }
117         void setHTTPUserAgent(const String& httpUserAgent) { setHTTPHeaderField("User-Agent", httpUserAgent); }
118
119         String httpAccept() const { return httpHeaderField("Accept"); }
120         void setHTTPAccept(const String& httpAccept) { setHTTPHeaderField("Accept", httpAccept); }
121
122         void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
123
124         FormData* httpBody() const;
125         void setHTTPBody(PassRefPtr<FormData> httpBody);
126         
127         bool allowCookies() const;
128         void setAllowCookies(bool allowCookies);
129
130         ResourceLoadPriority priority() const;
131         void setPriority(ResourceLoadPriority);
132
133         bool isConditional() const;
134
135         // Whether the associated ResourceHandleClient needs to be notified of
136         // upload progress made for that resource.
137         bool reportUploadProgress() const { return m_reportUploadProgress; }
138         void setReportUploadProgress(bool reportUploadProgress) { m_reportUploadProgress = reportUploadProgress; }
139
140         // Whether the timing information should be collected for the request.
141         bool reportLoadTiming() const { return m_reportLoadTiming; }
142         void setReportLoadTiming(bool reportLoadTiming) { m_reportLoadTiming = reportLoadTiming; }
143
144         // Whether actual headers being sent/received should be collected and reported for the request.
145         bool reportRawHeaders() const { return m_reportRawHeaders; }
146         void setReportRawHeaders(bool reportRawHeaders) { m_reportRawHeaders = reportRawHeaders; }
147
148         // What this request is for.
149         // FIXME: This should be moved out of ResourceRequestBase, <https://bugs.webkit.org/show_bug.cgi?id=48483>.
150         TargetType targetType() const { return m_targetType; }
151         void setTargetType(TargetType type) { m_targetType = type; }
152
153         static double defaultTimeoutInterval(); // May return 0 when using platform default.
154         static void setDefaultTimeoutInterval(double);
155
156         static bool compare(const ResourceRequest&, const ResourceRequest&);
157
158     protected:
159         // Used when ResourceRequest is initialized from a platform representation of the request
160         ResourceRequestBase()
161             : m_resourceRequestUpdated(false)
162             , m_platformRequestUpdated(true)
163             , m_reportUploadProgress(false)
164             , m_reportLoadTiming(false)
165             , m_reportRawHeaders(false)
166             , m_priority(ResourceLoadPriorityLow)
167             , m_targetType(TargetIsSubresource)
168         {
169         }
170
171         ResourceRequestBase(const KURL& url, ResourceRequestCachePolicy policy)
172             : m_url(url)
173             , m_cachePolicy(policy)
174             , m_timeoutInterval(s_defaultTimeoutInterval)
175             , m_httpMethod("GET")
176             , m_allowCookies(true)
177             , m_resourceRequestUpdated(true)
178             , m_platformRequestUpdated(false)
179             , m_reportUploadProgress(false)
180             , m_reportLoadTiming(false)
181             , m_reportRawHeaders(false)
182             , m_priority(ResourceLoadPriorityLow)
183             , m_targetType(TargetIsSubresource)
184         {
185         }
186
187         void updatePlatformRequest() const; 
188         void updateResourceRequest() const; 
189
190         // The ResourceRequest subclass may "shadow" this method to compare platform specific fields
191         static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
192
193         KURL m_url;
194
195         ResourceRequestCachePolicy m_cachePolicy;
196         double m_timeoutInterval; // 0 is a magic value for platform default on platforms that have one.
197         KURL m_firstPartyForCookies;
198         String m_httpMethod;
199         HTTPHeaderMap m_httpHeaderFields;
200         Vector<String> m_responseContentDispositionEncodingFallbackArray;
201         RefPtr<FormData> m_httpBody;
202         bool m_allowCookies;
203         mutable bool m_resourceRequestUpdated;
204         mutable bool m_platformRequestUpdated;
205         bool m_reportUploadProgress;
206         bool m_reportLoadTiming;
207         bool m_reportRawHeaders;
208         ResourceLoadPriority m_priority;
209         TargetType m_targetType;
210
211     private:
212         const ResourceRequest& asResourceRequest() const;
213
214         static double s_defaultTimeoutInterval;
215     };
216
217     bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
218
219     inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::compare(a, b); }
220     inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
221
222     struct CrossThreadResourceRequestDataBase {
223         WTF_MAKE_NONCOPYABLE(CrossThreadResourceRequestDataBase); WTF_MAKE_FAST_ALLOCATED;
224     public:
225         CrossThreadResourceRequestDataBase() { }
226         KURL m_url;
227
228         ResourceRequestCachePolicy m_cachePolicy;
229         double m_timeoutInterval;
230         KURL m_firstPartyForCookies;
231
232         String m_httpMethod;
233         OwnPtr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
234         Vector<String> m_responseContentDispositionEncodingFallbackArray;
235         RefPtr<FormData> m_httpBody;
236         bool m_allowCookies;
237         ResourceLoadPriority m_priority;
238         ResourceRequestBase::TargetType m_targetType;
239     };
240     
241     unsigned initializeMaximumHTTPConnectionCountPerHost();
242
243 #if PLATFORM(CF)
244     bool isHTTPPipeliningEnabled();
245     bool shouldForceHTTPPipeliningPriorityHigh();
246 #else
247     inline bool isHTTPPipeliningEnabled() { return false; }
248     inline bool shouldForceHTTPPipeliningPriorityHigh() { return false; }
249 #endif
250
251 } // namespace WebCore
252
253 #endif // ResourceRequestBase_h