Serialize ResourceResponses using WebKit types
[WebKit-https.git] / Source / WebCore / platform / network / ResourceResponseBase.h
1 /*
2  * Copyright (C) 2006, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef ResourceResponseBase_h
28 #define ResourceResponseBase_h
29
30 #include "HTTPHeaderMap.h"
31 #include "URL.h"
32 #include "ResourceLoadTiming.h"
33
34 #include <wtf/PassOwnPtr.h>
35 #include <wtf/RefPtr.h>
36
37 #if OS(SOLARIS)
38 #include <sys/time.h> // For time_t structure.
39 #endif
40
41 namespace WebCore {
42
43 class ResourceResponse;
44 struct CrossThreadResourceResponseData;
45
46 // Do not use this class directly, use the class ResponseResponse instead
47 class ResourceResponseBase {
48     WTF_MAKE_FAST_ALLOCATED;
49 public:
50     static PassOwnPtr<ResourceResponse> adopt(PassOwnPtr<CrossThreadResourceResponseData>);
51
52     // Gets a copy of the data suitable for passing to another thread.
53     PassOwnPtr<CrossThreadResourceResponseData> copyData() const;
54
55     bool isNull() const { return m_isNull; }
56     WEBCORE_EXPORT bool isHTTP() const;
57
58     WEBCORE_EXPORT const URL& url() const;
59     WEBCORE_EXPORT void setURL(const URL& url);
60
61     WEBCORE_EXPORT const String& mimeType() const;
62     WEBCORE_EXPORT void setMimeType(const String& mimeType);
63
64     WEBCORE_EXPORT long long expectedContentLength() const;
65     WEBCORE_EXPORT void setExpectedContentLength(long long expectedContentLength);
66
67     WEBCORE_EXPORT const String& textEncodingName() const;
68     WEBCORE_EXPORT void setTextEncodingName(const String& name);
69
70     WEBCORE_EXPORT int httpStatusCode() const;
71     WEBCORE_EXPORT void setHTTPStatusCode(int);
72     
73     WEBCORE_EXPORT const String& httpStatusText() const;
74     WEBCORE_EXPORT void setHTTPStatusText(const String&);
75
76     WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
77
78     String httpHeaderField(const String& name) const;
79     WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
80     WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
81     void setHTTPHeaderField(HTTPHeaderName, const String& value);
82
83     void addHTTPHeaderField(const String& name, const String& value);
84
85     // Instead of passing a string literal to any of these functions, just use a HTTPHeaderName instead.
86     template<size_t length> String httpHeaderField(const char (&)[length]) const = delete;
87     template<size_t length> void setHTTPHeaderField(const char (&)[length], const String&) = delete;
88     template<size_t length> void addHTTPHeaderField(const char (&)[length], const String&) = delete;
89
90     bool isMultipart() const { return mimeType() == "multipart/x-mixed-replace"; }
91
92     WEBCORE_EXPORT bool isAttachment() const;
93     WEBCORE_EXPORT String suggestedFilename() const;
94     
95     // These functions return parsed values of the corresponding response headers.
96     // NaN means that the header was not present or had invalid value.
97     bool cacheControlContainsNoCache() const;
98     bool cacheControlContainsNoStore() const;
99     bool cacheControlContainsMustRevalidate() const;
100     bool hasCacheValidatorFields() const;
101     double cacheControlMaxAge() const;
102     double date() const;
103     double age() const;
104     double expires() const;
105     WEBCORE_EXPORT double lastModified() const;
106
107     unsigned connectionID() const;
108     void setConnectionID(unsigned);
109
110     bool connectionReused() const;
111     void setConnectionReused(bool);
112
113     bool wasCached() const;
114     void setWasCached(bool);
115
116     ResourceLoadTiming& resourceLoadTiming() const { return m_resourceLoadTiming; }
117
118     // The ResourceResponse subclass may "shadow" this method to provide platform-specific memory usage information
119     unsigned memoryUsage() const
120     {
121         // average size, mostly due to URL and Header Map strings
122         return 1280;
123     }
124
125     static bool compare(const ResourceResponse&, const ResourceResponse&);
126
127     template<class Encoder> void encode(Encoder&) const;
128     template<class Decoder> static bool decode(Decoder&, ResourceResponseBase&);
129
130 protected:
131     enum InitLevel {
132         Uninitialized,
133         CommonFieldsOnly,
134         AllFields
135     };
136
137     WEBCORE_EXPORT ResourceResponseBase();
138     ResourceResponseBase(const URL&, const String& mimeType, long long expectedLength, const String& textEncodingName);
139
140     void lazyInit(InitLevel) const;
141
142     // The ResourceResponse subclass may "shadow" this method to lazily initialize platform specific fields
143     void platformLazyInit(InitLevel) { }
144     String platformSuggestedFileName() { return String(); }
145
146     // The ResourceResponse subclass may "shadow" this method to compare platform specific fields
147     static bool platformCompare(const ResourceResponse&, const ResourceResponse&) { return true; }
148
149     URL m_url;
150     AtomicString m_mimeType;
151     long long m_expectedContentLength;
152     AtomicString m_textEncodingName;
153     AtomicString m_httpStatusText;
154     HTTPHeaderMap m_httpHeaderFields;
155     mutable ResourceLoadTiming m_resourceLoadTiming;
156
157     int m_httpStatusCode;
158     unsigned m_connectionID;
159
160 private:
161     mutable double m_cacheControlMaxAge;
162     mutable double m_age;
163     mutable double m_date;
164     mutable double m_expires;
165     mutable double m_lastModified;
166
167 public:
168     bool m_wasCached : 1;
169     bool m_connectionReused : 1;
170
171     bool m_isNull : 1;
172     
173 private:
174     const ResourceResponse& asResourceResponse() const;
175     void parseCacheControlDirectives() const;
176     void updateHeaderParsedState(HTTPHeaderName);
177
178     mutable bool m_haveParsedCacheControlHeader : 1;
179     mutable bool m_haveParsedAgeHeader : 1;
180     mutable bool m_haveParsedDateHeader : 1;
181     mutable bool m_haveParsedExpiresHeader : 1;
182     mutable bool m_haveParsedLastModifiedHeader : 1;
183
184     mutable bool m_cacheControlContainsNoCache : 1;
185     mutable bool m_cacheControlContainsNoStore : 1;
186     mutable bool m_cacheControlContainsMustRevalidate : 1;
187 };
188
189 inline bool operator==(const ResourceResponse& a, const ResourceResponse& b) { return ResourceResponseBase::compare(a, b); }
190 inline bool operator!=(const ResourceResponse& a, const ResourceResponse& b) { return !(a == b); }
191
192 template<class Encoder>
193 void ResourceResponseBase::encode(Encoder& encoder) const
194 {
195     encoder << m_isNull;
196     if (m_isNull)
197         return;
198     lazyInit(AllFields);
199
200     encoder << m_url.string();
201     encoder << m_mimeType;
202     encoder << static_cast<int64_t>(m_expectedContentLength);
203     encoder << m_textEncodingName;
204     encoder << m_httpStatusText;
205     encoder << m_httpHeaderFields;
206     encoder << m_resourceLoadTiming;
207     encoder << m_httpStatusCode;
208     encoder << m_connectionID;
209 }
210
211 template<class Decoder>
212 bool ResourceResponseBase::decode(Decoder& decoder, ResourceResponseBase& response)
213 {
214     ASSERT(response.m_isNull);
215     bool responseIsNull;
216     if (!decoder.decode(responseIsNull))
217         return false;
218     if (responseIsNull)
219         return true;
220
221     String url;
222     if (!decoder.decode(url))
223         return false;
224     response.m_url = URL(URL(), url);
225     if (!decoder.decode(response.m_mimeType))
226         return false;
227     int64_t expectedContentLength;
228     if (!decoder.decode(expectedContentLength))
229         return false;
230     response.m_expectedContentLength = expectedContentLength;
231     if (!decoder.decode(response.m_textEncodingName))
232         return false;
233     if (!decoder.decode(response.m_httpStatusText))
234         return false;
235     if (!decoder.decode(response.m_httpHeaderFields))
236         return false;
237     if (!decoder.decode(response.m_resourceLoadTiming))
238         return false;
239     if (!decoder.decode(response.m_httpStatusCode))
240         return false;
241     if (!decoder.decode(response.m_connectionID))
242         return false;
243     response.m_isNull = false;
244
245     return true;
246 }
247
248 struct CrossThreadResourceResponseDataBase {
249     WTF_MAKE_NONCOPYABLE(CrossThreadResourceResponseDataBase); WTF_MAKE_FAST_ALLOCATED;
250 public:
251     CrossThreadResourceResponseDataBase() { }
252     URL m_url;
253     String m_mimeType;
254     long long m_expectedContentLength;
255     String m_textEncodingName;
256     int m_httpStatusCode;
257     String m_httpStatusText;
258     std::unique_ptr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
259     ResourceLoadTiming m_resourceLoadTiming;
260 };
261
262 } // namespace WebCore
263
264 #endif // ResourceResponseBase_h