2009-03-12 Xan Lopez <xlopez@igalia.com>
[WebKit-https.git] / 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 "KURL.h"
32
33 #include <memory>
34
35 namespace WebCore {
36
37 class ResourceResponse;
38 struct CrossThreadResourceResponseData;
39
40 // Do not use this class directly, use the class ResponseResponse instead
41 class ResourceResponseBase {
42 public:
43     static std::auto_ptr<ResourceResponse> adopt(std::auto_ptr<CrossThreadResourceResponseData>);
44
45     // Gets a copy of the data suitable for passing to another thread.
46     std::auto_ptr<CrossThreadResourceResponseData> copyData() const;
47
48     bool isNull() const { return m_isNull; }
49     bool isHTTP() const;
50
51     const KURL& url() const;
52     void setURL(const KURL& url);
53
54     const String& mimeType() const;
55     void setMimeType(const String& mimeType);
56
57     long long expectedContentLength() const;
58     void setExpectedContentLength(long long expectedContentLength);
59
60     const String& textEncodingName() const;
61     void setTextEncodingName(const String& name);
62
63     // FIXME should compute this on the fly
64     const String& suggestedFilename() const;
65     void setSuggestedFilename(const String&);
66
67     int httpStatusCode() const;
68     void setHTTPStatusCode(int);
69     
70     const String& httpStatusText() const;
71     void setHTTPStatusText(const String&);
72     
73     String httpHeaderField(const AtomicString& name) const;
74     void setHTTPHeaderField(const AtomicString& name, const String& value);
75     const HTTPHeaderMap& httpHeaderFields() const;
76
77     bool isMultipart() const { return mimeType() == "multipart/x-mixed-replace"; }
78
79     bool isAttachment() const;
80
81     void setExpirationDate(time_t);
82     time_t expirationDate() const;
83
84     void setLastModifiedDate(time_t);
85     time_t lastModifiedDate() const;
86
87     bool cacheControlContainsNoCache() const
88     {
89         if (!m_haveParsedCacheControl)
90             parseCacheControlDirectives();
91         return m_cacheControlContainsMustRevalidate;
92     }
93     bool cacheControlContainsMustRevalidate() const
94     {
95         if (!m_haveParsedCacheControl)
96             parseCacheControlDirectives();
97         return m_cacheControlContainsMustRevalidate;
98     }
99
100     // The ResourceResponse subclass may "shadow" this method to provide platform-specific memory usage information
101     unsigned memoryUsage() const
102     {
103         // average size, mostly due to URL and Header Map strings
104         return 1280;
105     }
106
107     static bool compare(const ResourceResponse& a, const ResourceResponse& b);
108
109 protected:
110     ResourceResponseBase()  
111         : m_expectedContentLength(0)
112         , m_httpStatusCode(0)
113         , m_expirationDate(0)
114         , m_lastModifiedDate(0)
115         , m_isNull(true)
116         , m_haveParsedCacheControl(false)
117     {
118     }
119
120     ResourceResponseBase(const KURL& url, const String& mimeType, long long expectedLength, const String& textEncodingName, const String& filename)
121         : m_url(url)
122         , m_mimeType(mimeType)
123         , m_expectedContentLength(expectedLength)
124         , m_textEncodingName(textEncodingName)
125         , m_suggestedFilename(filename)
126         , m_httpStatusCode(0)
127         , m_expirationDate(0)
128         , m_lastModifiedDate(0)
129         , m_isNull(false)
130         , m_haveParsedCacheControl(false)
131     {
132     }
133
134     void lazyInit() const;
135
136     // The ResourceResponse subclass may "shadow" this method to lazily initialize platform specific fields
137     void platformLazyInit() { }
138
139     // The ResourceResponse subclass may "shadow" this method to compare platform specific fields
140     static bool platformCompare(const ResourceResponse&, const ResourceResponse&) { return true; }
141
142     KURL m_url;
143     String m_mimeType;
144     long long m_expectedContentLength;
145     String m_textEncodingName;
146     String m_suggestedFilename;
147     int m_httpStatusCode;
148     String m_httpStatusText;
149     HTTPHeaderMap m_httpHeaderFields;
150     time_t m_expirationDate;
151     time_t m_lastModifiedDate;
152     bool m_isNull : 1;
153
154 private:
155     void parseCacheControlDirectives() const;
156
157     mutable bool m_haveParsedCacheControl : 1;
158     mutable bool m_cacheControlContainsMustRevalidate : 1;
159     mutable bool m_cacheControlContainsNoCache : 1;
160 };
161
162 inline bool operator==(const ResourceResponse& a, const ResourceResponse& b) { return ResourceResponseBase::compare(a, b); }
163 inline bool operator!=(const ResourceResponse& a, const ResourceResponse& b) { return !(a == b); }
164
165 struct CrossThreadResourceResponseData {
166     KURL m_url;
167     String m_mimeType;
168     long long m_expectedContentLength;
169     String m_textEncodingName;
170     String m_suggestedFilename;
171     int m_httpStatusCode;
172     String m_httpStatusText;
173     OwnPtr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
174     time_t m_expirationDate;
175     time_t m_lastModifiedDate;
176     bool m_haveParsedCacheControl : 1;
177     bool m_cacheControlContainsMustRevalidate : 1;
178     bool m_cacheControlContainsNoCache : 1;
179 };
180
181 } // namespace WebCore
182
183 #endif // ResourceResponseBase_h