2009-03-06 Jay Campan <jcampan@google.com>
[WebKit-https.git] / 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 <memory>
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     const int unspecifiedTimeoutInterval = INT_MAX;
48
49     struct ResourceRequest;
50     struct CrossThreadResourceRequestData;
51
52     // Do not use this type directly.  Use ResourceRequest instead.
53     class ResourceRequestBase {
54     public:
55         static std::auto_ptr<ResourceRequest> adopt(std::auto_ptr<CrossThreadResourceRequestData>);
56
57         // Gets a copy of the data suitable for passing to another thread.
58         std::auto_ptr<CrossThreadResourceRequestData> copyData() const;
59
60         bool isNull() const;
61         bool isEmpty() const;
62
63         const KURL& url() const;
64         void setURL(const KURL& url);
65
66         ResourceRequestCachePolicy cachePolicy() const;
67         void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
68         
69         double timeoutInterval() const;
70         void setTimeoutInterval(double timeoutInterval);
71         
72         const KURL& mainDocumentURL() const;
73         void setMainDocumentURL(const KURL& mainDocumentURL);
74         
75         const String& httpMethod() const;
76         void setHTTPMethod(const String& httpMethod);
77         
78         const HTTPHeaderMap& httpHeaderFields() const;
79         String httpHeaderField(const AtomicString& name) const;
80         void setHTTPHeaderField(const AtomicString& name, const String& value);
81         void addHTTPHeaderField(const AtomicString& name, const String& value);
82         void addHTTPHeaderFields(const HTTPHeaderMap& headerFields);
83         
84         String httpContentType() const { return httpHeaderField("Content-Type");  }
85         void setHTTPContentType(const String& httpContentType) { setHTTPHeaderField("Content-Type", httpContentType); }
86         
87         String httpReferrer() const { return httpHeaderField("Referer"); }
88         void setHTTPReferrer(const String& httpReferrer) { setHTTPHeaderField("Referer", httpReferrer); }
89         void clearHTTPReferrer() { m_httpHeaderFields.remove("Referer"); }
90         
91         String httpOrigin() const { return httpHeaderField("Origin"); }
92         void setHTTPOrigin(const String& httpOrigin) { setHTTPHeaderField("Origin", httpOrigin); }
93         void clearHTTPOrigin() { m_httpHeaderFields.remove("Origin"); }
94
95         String httpUserAgent() const { return httpHeaderField("User-Agent"); }
96         void setHTTPUserAgent(const String& httpUserAgent) { setHTTPHeaderField("User-Agent", httpUserAgent); }
97
98         String httpAccept() const { return httpHeaderField("Accept"); }
99         void setHTTPAccept(const String& httpAccept) { setHTTPHeaderField("Accept", httpAccept); }
100
101         void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
102
103         FormData* httpBody() const;
104         void setHTTPBody(PassRefPtr<FormData> httpBody);
105         
106         bool allowHTTPCookies() const;
107         void setAllowHTTPCookies(bool allowHTTPCookies);
108
109         bool isConditional() const;
110
111         // Whether the associated ResourceHandleClient needs to be notified of
112         // upload progress made for that resource.
113         bool reportUploadProgress() const { return m_reportUploadProgress; }
114         void setReportUploadProgress(bool reportUploadProgress) { m_reportUploadProgress = reportUploadProgress; }
115
116     protected:
117         // Used when ResourceRequest is initialized from a platform representation of the request
118         ResourceRequestBase()
119             : m_resourceRequestUpdated(false)
120             , m_platformRequestUpdated(true)
121             , m_reportUploadProgress(false)
122         {
123         }
124
125         ResourceRequestBase(const KURL& url, ResourceRequestCachePolicy policy)
126             : m_url(url)
127             , m_cachePolicy(policy)
128             , m_timeoutInterval(unspecifiedTimeoutInterval)
129             , m_httpMethod("GET")
130             , m_allowHTTPCookies(true)
131             , m_resourceRequestUpdated(true)
132             , m_platformRequestUpdated(false)
133             , m_reportUploadProgress(false)
134         {
135         }
136
137         void updatePlatformRequest() const; 
138         void updateResourceRequest() const; 
139
140         KURL m_url;
141
142         ResourceRequestCachePolicy m_cachePolicy;
143         double m_timeoutInterval;
144         KURL m_mainDocumentURL;
145         String m_httpMethod;
146         HTTPHeaderMap m_httpHeaderFields;
147         Vector<String> m_responseContentDispositionEncodingFallbackArray;
148         RefPtr<FormData> m_httpBody;
149         bool m_allowHTTPCookies;
150         mutable bool m_resourceRequestUpdated;
151         mutable bool m_platformRequestUpdated;
152         bool m_reportUploadProgress;
153
154     private:
155         const ResourceRequest& asResourceRequest() const;
156     };
157
158     bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
159
160     bool operator==(const ResourceRequestBase&, const ResourceRequestBase&);
161     inline bool operator!=(ResourceRequestBase& a, const ResourceRequestBase& b) { return !(a == b); }
162
163     struct CrossThreadResourceRequestData {
164         KURL m_url;
165
166         ResourceRequestCachePolicy m_cachePolicy;
167         double m_timeoutInterval;
168         KURL m_mainDocumentURL;
169
170         String m_httpMethod;
171         OwnPtr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
172         Vector<String> m_responseContentDispositionEncodingFallbackArray;
173         RefPtr<FormData> m_httpBody;
174         bool m_allowHTTPCookies;
175     };
176
177 } // namespace WebCore
178
179 #endif // ResourceRequestBase_h