9d838acc49703710af7c7cddadf2f36e3d990f9b
[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 COMPUTER, 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 COMPUTER, 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     bool isHTTP() const;
57
58     const URL& url() const;
59     void setURL(const URL& url);
60
61     const String& mimeType() const;
62     void setMimeType(const String& mimeType);
63
64     long long expectedContentLength() const;
65     void setExpectedContentLength(long long expectedContentLength);
66
67     const String& textEncodingName() const;
68     void setTextEncodingName(const String& name);
69
70     // FIXME: Should compute this on the fly.
71     // There should not be a setter exposed, as suggested file name is determined based on other headers in a manner that WebCore does not necessarily know about.
72     const String& suggestedFilename() const;
73     void setSuggestedFilename(const String&);
74
75     int httpStatusCode() const;
76     void setHTTPStatusCode(int);
77     
78     const String& httpStatusText() const;
79     void setHTTPStatusText(const String&);
80     
81     String httpHeaderField(const AtomicString& name) const;
82     String httpHeaderField(const char* name) const;
83     void setHTTPHeaderField(const AtomicString& name, const String& value);
84     void addHTTPHeaderField(const AtomicString& name, const String& value);
85     const HTTPHeaderMap& httpHeaderFields() const;
86
87     bool isMultipart() const { return mimeType() == "multipart/x-mixed-replace"; }
88
89     bool isAttachment() const;
90     
91     // These functions return parsed values of the corresponding response headers.
92     // NaN means that the header was not present or had invalid value.
93     bool cacheControlContainsNoCache() const;
94     bool cacheControlContainsNoStore() const;
95     bool cacheControlContainsMustRevalidate() const;
96     bool hasCacheValidatorFields() const;
97     double cacheControlMaxAge() const;
98     double date() const;
99     double age() const;
100     double expires() const;
101     double lastModified() const;
102
103     unsigned connectionID() const;
104     void setConnectionID(unsigned);
105
106     bool connectionReused() const;
107     void setConnectionReused(bool);
108
109     bool wasCached() const;
110     void setWasCached(bool);
111
112     ResourceLoadTiming* resourceLoadTiming() const;
113     void setResourceLoadTiming(PassRefPtr<ResourceLoadTiming>);
114
115     // The ResourceResponse subclass may "shadow" this method to provide platform-specific memory usage information
116     unsigned memoryUsage() const
117     {
118         // average size, mostly due to URL and Header Map strings
119         return 1280;
120     }
121
122     static bool compare(const ResourceResponse&, const ResourceResponse&);
123
124 protected:
125     enum InitLevel {
126         Uninitialized,
127         CommonFieldsOnly,
128         CommonAndUncommonFields,
129         AllFields
130     };
131
132     ResourceResponseBase();
133     ResourceResponseBase(const URL& url, const String& mimeType, long long expectedLength, const String& textEncodingName, const String& filename);
134
135     void lazyInit(InitLevel) const;
136
137     // The ResourceResponse subclass may "shadow" this method to lazily initialize platform specific fields
138     void platformLazyInit(InitLevel) { }
139
140     // The ResourceResponse subclass may "shadow" this method to compare platform specific fields
141     static bool platformCompare(const ResourceResponse&, const ResourceResponse&) { return true; }
142
143     URL m_url;
144     String m_mimeType;
145     long long m_expectedContentLength;
146     String m_textEncodingName;
147     String m_suggestedFilename;
148     String m_httpStatusText;
149     HTTPHeaderMap m_httpHeaderFields;
150     RefPtr<ResourceLoadTiming> m_resourceLoadTiming;
151
152     int m_httpStatusCode;
153     unsigned m_connectionID;
154
155 private:
156     mutable double m_cacheControlMaxAge;
157     mutable double m_age;
158     mutable double m_date;
159     mutable double m_expires;
160     mutable double m_lastModified;
161
162 public:
163     bool m_wasCached : 1;
164     bool m_connectionReused : 1;
165
166     bool m_isNull : 1;
167     
168 private:
169     const ResourceResponse& asResourceResponse() const;
170     void parseCacheControlDirectives() const;
171     void updateHeaderParsedState(const AtomicString& name);
172
173     mutable bool m_haveParsedCacheControlHeader : 1;
174     mutable bool m_haveParsedAgeHeader : 1;
175     mutable bool m_haveParsedDateHeader : 1;
176     mutable bool m_haveParsedExpiresHeader : 1;
177     mutable bool m_haveParsedLastModifiedHeader : 1;
178
179     mutable bool m_cacheControlContainsNoCache : 1;
180     mutable bool m_cacheControlContainsNoStore : 1;
181     mutable bool m_cacheControlContainsMustRevalidate : 1;
182 };
183
184 inline bool operator==(const ResourceResponse& a, const ResourceResponse& b) { return ResourceResponseBase::compare(a, b); }
185 inline bool operator!=(const ResourceResponse& a, const ResourceResponse& b) { return !(a == b); }
186
187 struct CrossThreadResourceResponseDataBase {
188     WTF_MAKE_NONCOPYABLE(CrossThreadResourceResponseDataBase); WTF_MAKE_FAST_ALLOCATED;
189 public:
190     CrossThreadResourceResponseDataBase() { }
191     URL m_url;
192     String m_mimeType;
193     long long m_expectedContentLength;
194     String m_textEncodingName;
195     String m_suggestedFilename;
196     int m_httpStatusCode;
197     String m_httpStatusText;
198     OwnPtr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
199     RefPtr<ResourceLoadTiming> m_resourceLoadTiming;
200 };
201
202 } // namespace WebCore
203
204 #endif // ResourceResponseBase_h