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