1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
|
/*
* Copyright (C) 2003, 2006 Apple Inc. All rights reserved.
* Copyright (C) 2006 Samuel Weinig <sam.weinig@gmail.com>
* Copyright (C) 2009, 2012 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "FormData.h"
#include "FrameLoaderTypes.h"
#include "HTTPHeaderMap.h"
#include "IntRect.h"
#include "ResourceLoadPriority.h"
#include <wtf/EnumTraits.h>
#include <wtf/URL.h>
namespace WebCore {
enum class ResourceRequestCachePolicy : uint8_t {
UseProtocolCachePolicy, // normal load, equivalent to fetch "default" cache mode.
ReloadIgnoringCacheData, // reload, equivalent to fetch "reload"cache mode.
ReturnCacheDataElseLoad, // back/forward or encoding change - allow stale data, equivalent to fetch "force-cache" cache mode.
ReturnCacheDataDontLoad, // results of a post - allow stale data and only use cache, equivalent to fetch "only-if-cached" cache mode.
DoNotUseAnyCache, // Bypass the cache entirely, equivalent to fetch "no-store" cache mode.
RefreshAnyCacheData, // Serve cache data only if revalidated, equivalent to fetch "no-cache" mode.
};
enum HTTPBodyUpdatePolicy : uint8_t {
DoNotUpdateHTTPBody,
UpdateHTTPBody
};
class ResourceRequest;
class ResourceResponse;
enum class ResourceRequestRequester : uint8_t { Unspecified, Main, XHR, Fetch, Media, Model, ImportScripts, Ping, Beacon, EventSource };
// Do not use this type directly. Use ResourceRequest instead.
class ResourceRequestBase {
WTF_MAKE_FAST_ALLOCATED;
public:
enum class SameSiteDisposition : uint8_t { Unspecified, SameSite, CrossSite };
struct RequestData {
RequestData() { }
RequestData(const URL& url, const URL& firstPartyForCookies, double timeoutInterval, const String& httpMethod, const HTTPHeaderMap& httpHeaderFields, const Vector<String>& responseContentDispositionEncodingFallbackArray, const ResourceRequestCachePolicy& cachePolicy, const SameSiteDisposition& sameSiteDisposition, const ResourceLoadPriority& priority, const ResourceRequestRequester& requester, bool allowCookies, bool isTopSite, bool isAppInitiated = true, bool privacyProxyFailClosedForUnreachableNonMainHosts = false, bool useAdvancedPrivacyProtections = false)
: m_url(url)
, m_firstPartyForCookies(firstPartyForCookies)
, m_timeoutInterval(timeoutInterval)
, m_httpMethod(httpMethod)
, m_httpHeaderFields(httpHeaderFields)
, m_responseContentDispositionEncodingFallbackArray(responseContentDispositionEncodingFallbackArray)
, m_cachePolicy(cachePolicy)
, m_sameSiteDisposition(sameSiteDisposition)
, m_priority(priority)
, m_requester(requester)
, m_isTopSite(isTopSite)
, m_allowCookies(allowCookies)
, m_isAppInitiated(isAppInitiated)
, m_privacyProxyFailClosedForUnreachableNonMainHosts(privacyProxyFailClosedForUnreachableNonMainHosts)
, m_useAdvancedPrivacyProtections(useAdvancedPrivacyProtections)
{
}
RequestData(const URL& url, ResourceRequestCachePolicy cachePolicy)
: m_url(url)
, m_cachePolicy(cachePolicy)
{
}
URL m_url;
URL m_firstPartyForCookies;
double m_timeoutInterval { s_defaultTimeoutInterval }; // 0 is a magic value for platform default on platforms that have one.
String m_httpMethod { "GET"_s };
HTTPHeaderMap m_httpHeaderFields;
Vector<String> m_responseContentDispositionEncodingFallbackArray;
ResourceRequestCachePolicy m_cachePolicy { ResourceRequestCachePolicy::UseProtocolCachePolicy };
SameSiteDisposition m_sameSiteDisposition { SameSiteDisposition::Unspecified };
ResourceLoadPriority m_priority { ResourceLoadPriority::Low };
ResourceRequestRequester m_requester { ResourceRequestRequester::Unspecified };
bool m_isTopSite : 1 { false };
bool m_allowCookies : 1 { false };
bool m_isAppInitiated : 1 { true };
bool m_privacyProxyFailClosedForUnreachableNonMainHosts : 1 { false };
bool m_useAdvancedPrivacyProtections : 1 { false };
};
ResourceRequestBase(RequestData&& requestData)
: m_requestData(WTFMove(requestData))
, m_resourceRequestUpdated(true)
, m_platformRequestUpdated(false)
, m_resourceRequestBodyUpdated(true)
, m_platformRequestBodyUpdated(false)
, m_hiddenFromInspector(false)
{
}
WEBCORE_EXPORT ResourceRequest isolatedCopy() const;
WEBCORE_EXPORT void setAsIsolatedCopy(const ResourceRequest&);
WEBCORE_EXPORT bool isNull() const;
WEBCORE_EXPORT bool isEmpty() const;
WEBCORE_EXPORT const URL& url() const;
WEBCORE_EXPORT void setURL(const URL& url);
void redirectAsGETIfNeeded(const ResourceRequestBase &, const ResourceResponse&);
enum class ShouldSetHash : bool { No, Yes };
WEBCORE_EXPORT ResourceRequest redirectedRequest(const ResourceResponse&, bool shouldClearReferrerOnHTTPSToHTTPRedirect, ShouldSetHash = ShouldSetHash::No) const;
WEBCORE_EXPORT void removeCredentials();
WEBCORE_EXPORT ResourceRequestCachePolicy cachePolicy() const;
WEBCORE_EXPORT void setCachePolicy(ResourceRequestCachePolicy cachePolicy);
WEBCORE_EXPORT double timeoutInterval() const; // May return 0 when using platform default.
WEBCORE_EXPORT void setTimeoutInterval(double);
WEBCORE_EXPORT const URL& firstPartyForCookies() const;
WEBCORE_EXPORT void setFirstPartyForCookies(const URL&);
WEBCORE_EXPORT bool isThirdParty() const;
// Same-Site cookies; see <https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00#section-2.1>
// and <https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00#section-5.2>.
// FIXME: For some reason the main resource request may be updated more than once. We start off as Unspecified
// to detect if we need to compute the same-site and top-site state or not. See FIXME in DocumentLoader::startLoadingMainResource().
bool isSameSiteUnspecified() const { return m_requestData.m_sameSiteDisposition == SameSiteDisposition::Unspecified; }
SameSiteDisposition sameSiteDisposition() const { return m_requestData.m_sameSiteDisposition; }
void setSameSiteDisposition(SameSiteDisposition disposition) { m_requestData.m_sameSiteDisposition = disposition; }
WEBCORE_EXPORT bool isSameSite() const; // Whether this request's registrable domain matches the request's initiator's "site for cookies".
WEBCORE_EXPORT void setIsSameSite(bool);
WEBCORE_EXPORT bool isTopSite() const; // Whether this request is for a top-level navigation.
WEBCORE_EXPORT void setIsTopSite(bool);
WEBCORE_EXPORT const String& httpMethod() const;
WEBCORE_EXPORT void setHTTPMethod(const String& httpMethod);
WEBCORE_EXPORT const HTTPHeaderMap& httpHeaderFields() const;
WEBCORE_EXPORT void setHTTPHeaderFields(HTTPHeaderMap);
WEBCORE_EXPORT String httpHeaderField(StringView name) const;
WEBCORE_EXPORT String httpHeaderField(HTTPHeaderName) const;
WEBCORE_EXPORT void setHTTPHeaderField(const String& name, const String& value);
WEBCORE_EXPORT void setHTTPHeaderField(HTTPHeaderName, const String& value);
WEBCORE_EXPORT void addHTTPHeaderField(HTTPHeaderName, const String& value);
WEBCORE_EXPORT void addHTTPHeaderField(const String& name, const String& value);
WEBCORE_EXPORT void addHTTPHeaderFieldIfNotPresent(HTTPHeaderName, const String&);
void removeHTTPHeaderField(const String& name);
void removeHTTPHeaderField(HTTPHeaderName);
WEBCORE_EXPORT bool hasHTTPHeaderField(HTTPHeaderName) const;
// Instead of passing a string literal to any of these functions, just use a HTTPHeaderName instead.
template<size_t length> String httpHeaderField(ASCIILiteral) const = delete;
template<size_t length> void setHTTPHeaderField(ASCIILiteral, const String&) = delete;
template<size_t length> void addHTTPHeaderField(ASCIILiteral, const String&) = delete;
WEBCORE_EXPORT void clearHTTPAuthorization();
WEBCORE_EXPORT String httpContentType() const;
WEBCORE_EXPORT void setHTTPContentType(const String&);
WEBCORE_EXPORT void clearHTTPContentType();
bool hasHTTPHeader(HTTPHeaderName) const;
WEBCORE_EXPORT String httpReferrer() const;
bool hasHTTPReferrer() const;
WEBCORE_EXPORT void setHTTPReferrer(const String&);
WEBCORE_EXPORT void setExistingHTTPReferrerToOriginString();
WEBCORE_EXPORT void clearHTTPReferrer();
WEBCORE_EXPORT String httpOrigin() const;
bool hasHTTPOrigin() const;
void setHTTPOrigin(const String&);
WEBCORE_EXPORT void clearHTTPOrigin();
WEBCORE_EXPORT String httpUserAgent() const;
WEBCORE_EXPORT void setHTTPUserAgent(const String&);
void clearHTTPUserAgent();
void clearHTTPAcceptEncoding();
WEBCORE_EXPORT void clearPurpose();
const Vector<String>& responseContentDispositionEncodingFallbackArray() const { return m_requestData.m_responseContentDispositionEncodingFallbackArray; }
WEBCORE_EXPORT void setResponseContentDispositionEncodingFallbackArray(const String& encoding1, const String& encoding2 = String(), const String& encoding3 = String());
void setResponseContentDispositionEncodingFallbackArray(const Vector<String>& array) { m_requestData.m_responseContentDispositionEncodingFallbackArray = array; }
WEBCORE_EXPORT RefPtr<FormData> httpBody() const;
WEBCORE_EXPORT bool hasUpload() const;
WEBCORE_EXPORT void setHTTPBody(RefPtr<FormData>&&);
bool platformRequestUpdated() const { return m_platformRequestUpdated; }
WEBCORE_EXPORT bool allowCookies() const;
WEBCORE_EXPORT void setAllowCookies(bool);
WEBCORE_EXPORT ResourceLoadPriority priority() const;
WEBCORE_EXPORT void setPriority(ResourceLoadPriority);
WEBCORE_EXPORT static String partitionName(const String& domain);
const String& cachePartition() const { return m_cachePartition; }
WEBCORE_EXPORT void setCachePartition(const String&);
void setDomainForCachePartition(const String& domain) { setCachePartition(partitionName(domain)); }
WEBCORE_EXPORT bool isConditional() const;
WEBCORE_EXPORT void makeUnconditional();
// Whether this request should be hidden from the Inspector.
bool hiddenFromInspector() const { return m_hiddenFromInspector; }
void setHiddenFromInspector(bool hiddenFromInspector) { m_hiddenFromInspector = hiddenFromInspector; }
ResourceRequestRequester requester() const { return m_requestData.m_requester; }
void setRequester(ResourceRequestRequester requester) { m_requestData.m_requester = requester; }
// Who initiated the request so the Inspector can associate it with a context. E.g. a Web Worker.
String initiatorIdentifier() const { return m_initiatorIdentifier; }
void setInitiatorIdentifier(const String& identifier) { m_initiatorIdentifier = identifier; }
// Additional information for the Inspector to be able to identify the node that initiated this request.
const std::optional<int>& inspectorInitiatorNodeIdentifier() const { return m_inspectorInitiatorNodeIdentifier; }
void setInspectorInitiatorNodeIdentifier(int inspectorInitiatorNodeIdentifier) { m_inspectorInitiatorNodeIdentifier = inspectorInitiatorNodeIdentifier; }
void upgradeToHTTPS();
#if !PLATFORM(COCOA) && !USE(SOUP)
bool encodingRequiresPlatformData() const { return true; }
#endif
WEBCORE_EXPORT static double defaultTimeoutInterval(); // May return 0 when using platform default.
WEBCORE_EXPORT static void setDefaultTimeoutInterval(double);
WEBCORE_EXPORT static bool equal(const ResourceRequest&, const ResourceRequest&);
bool isAppInitiated() const { return m_requestData.m_isAppInitiated; }
WEBCORE_EXPORT void setIsAppInitiated(bool);
bool privacyProxyFailClosedForUnreachableNonMainHosts() const { return m_requestData.m_privacyProxyFailClosedForUnreachableNonMainHosts; }
WEBCORE_EXPORT void setPrivacyProxyFailClosedForUnreachableNonMainHosts(bool);
bool useAdvancedPrivacyProtections() const { return m_requestData.m_useAdvancedPrivacyProtections; }
WEBCORE_EXPORT void setUseAdvancedPrivacyProtections(bool);
protected:
// Used when ResourceRequest is initialized from a platform representation of the request
ResourceRequestBase()
: m_requestData()
, m_resourceRequestUpdated(false)
, m_platformRequestUpdated(true)
, m_resourceRequestBodyUpdated(false)
, m_platformRequestBodyUpdated(true)
, m_hiddenFromInspector(false)
{
}
ResourceRequestBase(const URL& url, ResourceRequestCachePolicy policy)
: m_requestData({ url, policy })
, m_resourceRequestUpdated(true)
, m_platformRequestUpdated(false)
, m_resourceRequestBodyUpdated(true)
, m_platformRequestBodyUpdated(false)
, m_hiddenFromInspector(false)
{
m_requestData.m_allowCookies = true;
}
void updatePlatformRequest(HTTPBodyUpdatePolicy = HTTPBodyUpdatePolicy::DoNotUpdateHTTPBody) const;
void updateResourceRequest(HTTPBodyUpdatePolicy = HTTPBodyUpdatePolicy::DoNotUpdateHTTPBody) const;
// The ResourceRequest subclass may "shadow" this method to compare platform specific fields
static bool platformCompare(const ResourceRequest&, const ResourceRequest&) { return true; }
RequestData m_requestData;
String m_initiatorIdentifier;
String m_cachePartition { emptyString() };
RefPtr<FormData> m_httpBody;
std::optional<int> m_inspectorInitiatorNodeIdentifier;
mutable bool m_resourceRequestUpdated : 1;
mutable bool m_platformRequestUpdated : 1;
mutable bool m_resourceRequestBodyUpdated : 1;
mutable bool m_platformRequestBodyUpdated : 1;
bool m_hiddenFromInspector : 1;
private:
const ResourceRequest& asResourceRequest() const;
WEBCORE_EXPORT static double s_defaultTimeoutInterval;
};
bool equalIgnoringHeaderFields(const ResourceRequestBase&, const ResourceRequestBase&);
inline bool operator==(const ResourceRequest& a, const ResourceRequest& b) { return ResourceRequestBase::equal(a, b); }
WEBCORE_EXPORT unsigned initializeMaximumHTTPConnectionCountPerHost();
#if PLATFORM(IOS_FAMILY)
WEBCORE_EXPORT void initializeHTTPConnectionSettingsOnStartup();
#endif
} // namespace WebCore
namespace WTF {
template<> struct EnumTraitsForPersistence<WebCore::ResourceRequestCachePolicy> {
using values = EnumValues<
WebCore::ResourceRequestCachePolicy,
WebCore::ResourceRequestCachePolicy::UseProtocolCachePolicy,
WebCore::ResourceRequestCachePolicy::ReloadIgnoringCacheData,
WebCore::ResourceRequestCachePolicy::ReturnCacheDataElseLoad,
WebCore::ResourceRequestCachePolicy::ReturnCacheDataDontLoad,
WebCore::ResourceRequestCachePolicy::DoNotUseAnyCache,
WebCore::ResourceRequestCachePolicy::RefreshAnyCacheData
>;
};
template<> struct EnumTraitsForPersistence<WebCore::ResourceRequestBase::SameSiteDisposition> {
using values = EnumValues<
WebCore::ResourceRequestBase::SameSiteDisposition,
WebCore::ResourceRequestBase::SameSiteDisposition::Unspecified,
WebCore::ResourceRequestBase::SameSiteDisposition::SameSite,
WebCore::ResourceRequestBase::SameSiteDisposition::CrossSite
>;
};
template<> struct EnumTraitsForPersistence<WebCore::ResourceRequestRequester> {
using values = EnumValues<
WebCore::ResourceRequestRequester,
WebCore::ResourceRequestRequester::Unspecified,
WebCore::ResourceRequestRequester::Main,
WebCore::ResourceRequestRequester::XHR,
WebCore::ResourceRequestRequester::Fetch,
WebCore::ResourceRequestRequester::Media,
WebCore::ResourceRequestRequester::ImportScripts,
WebCore::ResourceRequestRequester::Ping,
WebCore::ResourceRequestRequester::Beacon,
WebCore::ResourceRequestRequester::EventSource
>;
};
} // namespace WTF
|