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