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