dce33db6cbb66ae6f163f26501809d737a478f69
[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 "KURL.h"
33 #include "HTTPHeaderMap.h"
34
35 #include <wtf/OwnPtr.h>
36
37 namespace WebCore {
38
39     enum ResourceRequestCachePolicy {
40         UseProtocolCachePolicy, // normal load
41         ReloadIgnoringCacheData, // reload
42         ReturnCacheDataElseLoad, // back/forward or encoding change - allow stale data
43         ReturnCacheDataDontLoad, // results of a post - allow stale data and only use cache
44     };
45
46     const int unspecifiedTimeoutInterval = INT_MAX;
47
48     class ResourceRequest;
49     struct CrossThreadResourceRequestData;
50
51     // Do not use this type directly.  Use ResourceRequest instead.
52     class ResourceRequestBase {
53         WTF_MAKE_FAST_ALLOCATED;
54     public:
55         // The type of this ResourceRequest, based on how the resource will be used.
56         enum TargetType {
57             TargetIsMainFrame,
58             TargetIsSubframe,
59             TargetIsSubresource,  // Resource is a generic subresource.  (Generally a specific type should be specified)
60             TargetIsStyleSheet,
61             TargetIsScript,
62             TargetIsFontResource,
63             TargetIsImage,
64             TargetIsObject,
65             TargetIsMedia,
66             TargetIsWorker,
67             TargetIsSharedWorker,
68             TargetIsPrefetch,
69         };
70
71         static PassOwnPtr<ResourceRequest> adopt(PassOwnPtr<CrossThreadResourceRequestData>);
72
73         // Gets a copy of the data suitable for passing to another thread.
74         PassOwnPtr<CrossThreadResourceRequestData> copyData() const;
75
76         bool isNull() const;
77         bool isEmpty() const;
78
79         const KURL& url() const;
80         void setURL(const KURL& url);
81
82         void removeCredentials();
83
84         ResourceRequestCachePolicy cachePolicy() const;
85         void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
86         
87         double timeoutInterval() const;
88         void setTimeoutInterval(double timeoutInterval);
89         
90         const KURL& firstPartyForCookies() const;
91         void setFirstPartyForCookies(const KURL& firstPartyForCookies);
92         
93         const String& httpMethod() const;
94         void setHTTPMethod(const String& httpMethod);
95         
96         const HTTPHeaderMap& httpHeaderFields() const;
97         String httpHeaderField(const AtomicString& name) const;
98         String httpHeaderField(const char* name) const;
99         void setHTTPHeaderField(const AtomicString& name, const String& value);
100         void setHTTPHeaderField(const char* name, const String& value);
101         void addHTTPHeaderField(const AtomicString& name, const String& value);
102         void addHTTPHeaderFields(const HTTPHeaderMap& headerFields);
103         
104         void clearHTTPAuthorization();
105
106         String httpContentType() const { return httpHeaderField("Content-Type");  }
107         void setHTTPContentType(const String& httpContentType) { setHTTPHeaderField("Content-Type", httpContentType); }
108         
109         String httpReferrer() const { return httpHeaderField("Referer"); }
110         void setHTTPReferrer(const String& httpReferrer) { setHTTPHeaderField("Referer", httpReferrer); }
111         void clearHTTPReferrer();
112         
113         String httpOrigin() const { return httpHeaderField("Origin"); }
114         void setHTTPOrigin(const String& httpOrigin) { setHTTPHeaderField("Origin", httpOrigin); }
115         void clearHTTPOrigin();
116
117         String httpUserAgent() const { return httpHeaderField("User-Agent"); }
118         void setHTTPUserAgent(const String& httpUserAgent) { setHTTPHeaderField("User-Agent", httpUserAgent); }
119
120         String httpAccept() const { return httpHeaderField("Accept"); }
121         void setHTTPAccept(const String& httpAccept) { setHTTPHeaderField("Accept", httpAccept); }
122
123         void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
124
125         FormData* httpBody() const;
126         void setHTTPBody(PassRefPtr<FormData> httpBody);
127         
128         bool allowCookies() const;
129         void setAllowCookies(bool allowCookies);
130
131         bool isConditional() const;
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         // What this request is for.
147         TargetType targetType() const { return m_targetType; }
148         void setTargetType(TargetType type) { m_targetType = type; }
149
150         static bool compare(const ResourceRequest&, const ResourceRequest&);
151
152     protected:
153         // Used when ResourceRequest is initialized from a platform representation of the request
154         ResourceRequestBase()
155             : m_resourceRequestUpdated(false)
156             , m_platformRequestUpdated(true)
157             , m_reportUploadProgress(false)
158             , m_reportLoadTiming(false)
159             , m_reportRawHeaders(false)
160             , m_targetType(TargetIsSubresource)
161         {
162         }
163
164         ResourceRequestBase(const KURL& url, ResourceRequestCachePolicy policy)
165             : m_url(url)
166             , m_cachePolicy(policy)
167             , m_timeoutInterval(unspecifiedTimeoutInterval)
168             , m_httpMethod("GET")
169             , m_allowCookies(true)
170             , m_resourceRequestUpdated(true)
171             , m_platformRequestUpdated(false)
172             , m_reportUploadProgress(false)
173             , m_reportLoadTiming(false)
174             , m_reportRawHeaders(false)
175             , m_targetType(TargetIsSubresource)
176         {
177         }
178
179         void updatePlatformRequest() const; 
180         void updateResourceRequest() const; 
181
182         // The ResourceRequest subclass may "shadow" this method to compare platform specific fields
183         static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
184
185         KURL m_url;
186
187         ResourceRequestCachePolicy m_cachePolicy;
188         double m_timeoutInterval;
189         KURL m_firstPartyForCookies;
190         String m_httpMethod;
191         HTTPHeaderMap m_httpHeaderFields;
192         Vector<String> m_responseContentDispositionEncodingFallbackArray;
193         RefPtr<FormData> m_httpBody;
194         bool m_allowCookies;
195         mutable bool m_resourceRequestUpdated;
196         mutable bool m_platformRequestUpdated;
197         bool m_reportUploadProgress;
198         bool m_reportLoadTiming;
199         bool m_reportRawHeaders;
200         TargetType m_targetType;
201
202     private:
203         const ResourceRequest& asResourceRequest() const;
204     };
205
206     bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
207
208     inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::compare(a, b); }
209     inline bool operator!=(ResourceRequest& a, const ResourceRequest& b) { return !(a == b); }
210
211     struct CrossThreadResourceRequestDataBase {
212         WTF_MAKE_NONCOPYABLE(CrossThreadResourceRequestDataBase); WTF_MAKE_FAST_ALLOCATED;
213     public:
214         CrossThreadResourceRequestDataBase() { }
215         KURL m_url;
216
217         ResourceRequestCachePolicy m_cachePolicy;
218         double m_timeoutInterval;
219         KURL m_firstPartyForCookies;
220
221         String m_httpMethod;
222         OwnPtr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
223         Vector<String> m_responseContentDispositionEncodingFallbackArray;
224         RefPtr<FormData> m_httpBody;
225         bool m_allowCookies;
226         ResourceRequestBase::TargetType m_targetType;
227     };
228     
229     unsigned initializeMaximumHTTPConnectionCountPerHost();
230
231 } // namespace WebCore
232
233 #endif // ResourceRequestBase_h