Remove ResourceResponse::m_suggestedFilename
[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 protected:
128     enum InitLevel {
129         Uninitialized,
130         CommonFieldsOnly,
131         AllFields
132     };
133
134     WEBCORE_EXPORT ResourceResponseBase();
135     ResourceResponseBase(const URL&, const String& mimeType, long long expectedLength, const String& textEncodingName);
136
137     void lazyInit(InitLevel) const;
138
139     // The ResourceResponse subclass may "shadow" this method to lazily initialize platform specific fields
140     void platformLazyInit(InitLevel) { }
141     String platformSuggestedFileName() { return String(); }
142
143     // The ResourceResponse subclass may "shadow" this method to compare platform specific fields
144     static bool platformCompare(const ResourceResponse&, const ResourceResponse&) { return true; }
145
146     URL m_url;
147     AtomicString m_mimeType;
148     long long m_expectedContentLength;
149     AtomicString m_textEncodingName;
150     AtomicString m_httpStatusText;
151     HTTPHeaderMap m_httpHeaderFields;
152     mutable ResourceLoadTiming m_resourceLoadTiming;
153
154     int m_httpStatusCode;
155     unsigned m_connectionID;
156
157 private:
158     mutable double m_cacheControlMaxAge;
159     mutable double m_age;
160     mutable double m_date;
161     mutable double m_expires;
162     mutable double m_lastModified;
163
164 public:
165     bool m_wasCached : 1;
166     bool m_connectionReused : 1;
167
168     bool m_isNull : 1;
169     
170 private:
171     const ResourceResponse& asResourceResponse() const;
172     void parseCacheControlDirectives() const;
173     void updateHeaderParsedState(HTTPHeaderName);
174
175     mutable bool m_haveParsedCacheControlHeader : 1;
176     mutable bool m_haveParsedAgeHeader : 1;
177     mutable bool m_haveParsedDateHeader : 1;
178     mutable bool m_haveParsedExpiresHeader : 1;
179     mutable bool m_haveParsedLastModifiedHeader : 1;
180
181     mutable bool m_cacheControlContainsNoCache : 1;
182     mutable bool m_cacheControlContainsNoStore : 1;
183     mutable bool m_cacheControlContainsMustRevalidate : 1;
184 };
185
186 inline bool operator==(const ResourceResponse& a, const ResourceResponse& b) { return ResourceResponseBase::compare(a, b); }
187 inline bool operator!=(const ResourceResponse& a, const ResourceResponse& b) { return !(a == b); }
188
189 struct CrossThreadResourceResponseDataBase {
190     WTF_MAKE_NONCOPYABLE(CrossThreadResourceResponseDataBase); WTF_MAKE_FAST_ALLOCATED;
191 public:
192     CrossThreadResourceResponseDataBase() { }
193     URL m_url;
194     String m_mimeType;
195     long long m_expectedContentLength;
196     String m_textEncodingName;
197     int m_httpStatusCode;
198     String m_httpStatusText;
199     std::unique_ptr<CrossThreadHTTPHeaderMapData> m_httpHeaders;
200     ResourceLoadTiming m_resourceLoadTiming;
201 };
202
203 } // namespace WebCore
204
205 #endif // ResourceResponseBase_h