e15eb213c712eaafc8dfa13fceedd1e537ca865e
[WebKit-https.git] / Source / WebCore / platform / network / ResourceResponseBase.h
1 /*
2  * Copyright (C) 2006, 2008, 2016 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 #pragma once
28
29 #include "CacheValidation.h"
30 #include "CertificateInfo.h"
31 #include "HTTPHeaderMap.h"
32 #include "NetworkLoadMetrics.h"
33 #include "ParsedContentRange.h"
34 #include "URL.h"
35 #include <wtf/SHA1.h>
36
37 namespace WebCore {
38
39 class ResourceResponse;
40
41 bool isScriptAllowedByNosniff(const ResourceResponse&);
42
43 // Do not use this class directly, use the class ResponseResponse instead
44 class ResourceResponseBase {
45     WTF_MAKE_FAST_ALLOCATED;
46 public:
47     enum class Type;
48
49     struct CrossThreadData {
50         CrossThreadData(const CrossThreadData&) = delete;
51         CrossThreadData& operator=(const CrossThreadData&) = delete;
52         CrossThreadData() = default;
53         CrossThreadData(CrossThreadData&&) = default;
54
55         URL url;
56         String mimeType;
57         long long expectedContentLength;
58         String textEncodingName;
59         int httpStatusCode;
60         String httpStatusText;
61         String httpVersion;
62         HTTPHeaderMap httpHeaderFields;
63         NetworkLoadMetrics networkLoadMetrics;
64         Type type;
65         bool isRedirected;
66     };
67
68     CrossThreadData crossThreadData() const;
69     static ResourceResponse fromCrossThreadData(CrossThreadData&&);
70
71     enum class Tainting { Basic, Cors, Opaque };
72     static ResourceResponse filterResponse(const ResourceResponse&, Tainting);
73
74     bool isNull() const { return m_isNull; }
75     WEBCORE_EXPORT bool isHTTP() const;
76     bool isSuccessful() const;
77
78     WEBCORE_EXPORT const URL& url() const;
79     WEBCORE_EXPORT void setURL(const URL&);
80
81     WEBCORE_EXPORT const String& mimeType() const;
82     WEBCORE_EXPORT void setMimeType(const String& mimeType);
83
84     WEBCORE_EXPORT long long expectedContentLength() const;
85     WEBCORE_EXPORT void setExpectedContentLength(long long expectedContentLength);
86
87     WEBCORE_EXPORT const String& textEncodingName() const;
88     WEBCORE_EXPORT void setTextEncodingName(const String& name);
89
90     WEBCORE_EXPORT int httpStatusCode() const;
91     WEBCORE_EXPORT void setHTTPStatusCode(int);
92
93     WEBCORE_EXPORT const String& httpStatusText() const;
94     WEBCORE_EXPORT void setHTTPStatusText(const String&);
95
96     WEBCORE_EXPORT const String& httpVersion() const;
97     WEBCORE_EXPORT void setHTTPVersion(const String&);
98     WEBCORE_EXPORT bool isHTTP09() const;
99
100     WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
101
102     String httpHeaderField(const String& name) const;
103     WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
104     WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
105     WEBCORE_EXPORT void setHTTPHeaderField(HTTPHeaderName, const String& value);
106
107     void addHTTPHeaderField(HTTPHeaderName, const String& value);
108     void addHTTPHeaderField(const String& name, const String& value);
109
110     // Instead of passing a string literal to any of these functions, just use a HTTPHeaderName instead.
111     template<size_t length> String httpHeaderField(const char (&)[length]) const = delete;
112     template<size_t length> void setHTTPHeaderField(const char (&)[length], const String&) = delete;
113     template<size_t length> void addHTTPHeaderField(const char (&)[length], const String&) = delete;
114
115     bool isMultipart() const { return mimeType() == "multipart/x-mixed-replace"; }
116
117     WEBCORE_EXPORT bool isAttachment() const;
118     WEBCORE_EXPORT bool isAttachmentWithFilename() const;
119     WEBCORE_EXPORT String suggestedFilename() const;
120     WEBCORE_EXPORT static String sanitizeSuggestedFilename(const String&);
121
122     WEBCORE_EXPORT void includeCertificateInfo() const;
123     const std::optional<CertificateInfo>& certificateInfo() const { return m_certificateInfo; };
124     
125     // These functions return parsed values of the corresponding response headers.
126     WEBCORE_EXPORT bool cacheControlContainsNoCache() const;
127     WEBCORE_EXPORT bool cacheControlContainsNoStore() const;
128     WEBCORE_EXPORT bool cacheControlContainsMustRevalidate() const;
129     WEBCORE_EXPORT bool cacheControlContainsImmutable() const;
130     WEBCORE_EXPORT bool hasCacheValidatorFields() const;
131     WEBCORE_EXPORT std::optional<std::chrono::microseconds> cacheControlMaxAge() const;
132     WEBCORE_EXPORT std::optional<std::chrono::system_clock::time_point> date() const;
133     WEBCORE_EXPORT std::optional<std::chrono::microseconds> age() const;
134     WEBCORE_EXPORT std::optional<std::chrono::system_clock::time_point> expires() const;
135     WEBCORE_EXPORT std::optional<std::chrono::system_clock::time_point> lastModified() const;
136     ParsedContentRange& contentRange() const;
137
138     enum class Source { Unknown, Network, DiskCache, DiskCacheAfterValidation, MemoryCache, MemoryCacheAfterValidation };
139     WEBCORE_EXPORT Source source() const;
140     void setSource(Source source) { m_source = source; }
141
142     const std::optional<SHA1::Digest>& cacheBodyKey() const { return m_cacheBodyKey; }
143     void setCacheBodyKey(const SHA1::Digest& key) { m_cacheBodyKey = key; }
144
145     // FIXME: This should be eliminated from ResourceResponse.
146     // Network loading metrics should be delivered via didFinishLoad
147     // and should not be part of the ResourceResponse.
148     NetworkLoadMetrics& deprecatedNetworkLoadMetrics() const { return m_networkLoadMetrics; }
149
150     // The ResourceResponse subclass may "shadow" this method to provide platform-specific memory usage information
151     unsigned memoryUsage() const
152     {
153         // average size, mostly due to URL and Header Map strings
154         return 1280;
155     }
156
157     enum class Type { Basic, Cors, Default, Error, Opaque, Opaqueredirect };
158     Type type() const { return m_type; }
159     void setType(Type type) { m_type = type; }
160     bool isRedirected() const { return m_isRedirected; }
161     void setRedirected(bool isRedirected) { m_isRedirected = isRedirected; }
162
163     static bool compare(const ResourceResponse&, const ResourceResponse&);
164
165     template<class Encoder> void encode(Encoder&) const;
166     template<class Decoder> static bool decode(Decoder&, ResourceResponseBase&);
167
168 protected:
169     enum InitLevel {
170         Uninitialized,
171         CommonFieldsOnly,
172         AllFields
173     };
174
175     WEBCORE_EXPORT ResourceResponseBase();
176     WEBCORE_EXPORT ResourceResponseBase(const URL&, const String& mimeType, long long expectedLength, const String& textEncodingName);
177
178     WEBCORE_EXPORT void lazyInit(InitLevel) const;
179
180     // The ResourceResponse subclass should shadow these functions to lazily initialize platform specific fields
181     void platformLazyInit(InitLevel) { }
182     CertificateInfo platformCertificateInfo() const { return CertificateInfo(); };
183     String platformSuggestedFileName() const { return String(); }
184
185     static bool platformCompare(const ResourceResponse&, const ResourceResponse&) { return true; }
186
187 private:
188     void parseCacheControlDirectives() const;
189     void updateHeaderParsedState(HTTPHeaderName);
190
191 protected:
192     bool m_isNull;
193     URL m_url;
194     AtomicString m_mimeType;
195     long long m_expectedContentLength;
196     AtomicString m_textEncodingName;
197     AtomicString m_httpStatusText;
198     AtomicString m_httpVersion;
199     HTTPHeaderMap m_httpHeaderFields;
200     mutable NetworkLoadMetrics m_networkLoadMetrics;
201
202     mutable std::optional<CertificateInfo> m_certificateInfo;
203
204     int m_httpStatusCode;
205
206 private:
207     mutable std::optional<std::chrono::microseconds> m_age;
208     mutable std::optional<std::chrono::system_clock::time_point> m_date;
209     mutable std::optional<std::chrono::system_clock::time_point> m_expires;
210     mutable std::optional<std::chrono::system_clock::time_point> m_lastModified;
211     mutable ParsedContentRange m_contentRange;
212     mutable CacheControlDirectives m_cacheControlDirectives;
213
214     mutable bool m_haveParsedCacheControlHeader { false };
215     mutable bool m_haveParsedAgeHeader { false };
216     mutable bool m_haveParsedDateHeader { false };
217     mutable bool m_haveParsedExpiresHeader { false };
218     mutable bool m_haveParsedLastModifiedHeader { false };
219     mutable bool m_haveParsedContentRangeHeader { false };
220
221     Source m_source { Source::Unknown };
222
223     std::optional<SHA1::Digest> m_cacheBodyKey;
224
225     Type m_type { Type::Default };
226     bool m_isRedirected { false };
227 };
228
229 inline bool operator==(const ResourceResponse& a, const ResourceResponse& b) { return ResourceResponseBase::compare(a, b); }
230 inline bool operator!=(const ResourceResponse& a, const ResourceResponse& b) { return !(a == b); }
231
232 template<class Encoder>
233 void ResourceResponseBase::encode(Encoder& encoder) const
234 {
235     encoder << m_isNull;
236     if (m_isNull)
237         return;
238     lazyInit(AllFields);
239
240     encoder << m_url;
241     encoder << m_mimeType;
242     encoder << static_cast<int64_t>(m_expectedContentLength);
243     encoder << m_textEncodingName;
244     encoder << m_httpStatusText;
245     encoder << m_httpVersion;
246     encoder << m_httpHeaderFields;
247
248     // We don't want to put the networkLoadMetrics info
249     // into the disk cache, because we will never use the old info.
250     if (Encoder::isIPCEncoder)
251         encoder << m_networkLoadMetrics;
252
253     encoder << m_httpStatusCode;
254     encoder << m_certificateInfo;
255     encoder.encodeEnum(m_source);
256     encoder << m_cacheBodyKey;
257     encoder.encodeEnum(m_type);
258     encoder << m_isRedirected;
259 }
260
261 template<class Decoder>
262 bool ResourceResponseBase::decode(Decoder& decoder, ResourceResponseBase& response)
263 {
264     ASSERT(response.m_isNull);
265     bool responseIsNull;
266     if (!decoder.decode(responseIsNull))
267         return false;
268     if (responseIsNull)
269         return true;
270
271     if (!decoder.decode(response.m_url))
272         return false;
273     if (!decoder.decode(response.m_mimeType))
274         return false;
275     int64_t expectedContentLength;
276     if (!decoder.decode(expectedContentLength))
277         return false;
278     response.m_expectedContentLength = expectedContentLength;
279     if (!decoder.decode(response.m_textEncodingName))
280         return false;
281     if (!decoder.decode(response.m_httpStatusText))
282         return false;
283     if (!decoder.decode(response.m_httpVersion))
284         return false;
285     if (!decoder.decode(response.m_httpHeaderFields))
286         return false;
287     // The networkLoadMetrics info is only send over IPC and not stored in disk cache.
288     if (Decoder::isIPCDecoder && !decoder.decode(response.m_networkLoadMetrics))
289         return false;
290     if (!decoder.decode(response.m_httpStatusCode))
291         return false;
292     if (!decoder.decode(response.m_certificateInfo))
293         return false;
294     if (!decoder.decodeEnum(response.m_source))
295         return false;
296     if (!decoder.decode(response.m_cacheBodyKey))
297         return false;
298     if (!decoder.decodeEnum(response.m_type))
299         return false;
300     if (!decoder.decode(response.m_isRedirected))
301         return false;
302     response.m_isNull = false;
303
304     return true;
305 }
306
307 } // namespace WebCore