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 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
|
/*
* Copyright (C) 2003, 2006 Apple Computer, 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 COMPUTER, 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 COMPUTER, 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.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_LOADER_FETCH_RESOURCE_REQUEST_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_LOADER_FETCH_RESOURCE_REQUEST_H_
#include <memory>
#include <optional>
#include "base/containers/flat_set.h"
#include "base/time/time.h"
#include "base/unguessable_token.h"
#include "net/cookies/site_for_cookies.h"
#include "net/filter/source_stream_type.h"
#include "net/storage_access_api/status.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "services/network/public/cpp/fetch_retry_options.h"
#include "services/network/public/mojom/attribution.mojom-blink.h"
#include "services/network/public/mojom/chunked_data_pipe_getter.mojom-blink-forward.h"
#include "services/network/public/mojom/cors.mojom-blink-forward.h"
#include "services/network/public/mojom/fetch_api.mojom-blink.h"
#include "services/network/public/mojom/ip_address_space.mojom-blink-forward.h"
#include "services/network/public/mojom/permissions_policy/permissions_policy_feature.mojom-blink-forward.h"
#include "services/network/public/mojom/trust_tokens.mojom-blink.h"
#include "services/network/public/mojom/web_bundle_handle.mojom-blink.h"
#include "third_party/blink/public/mojom/fetch/fetch_api_request.mojom-blink-forward.h"
#include "third_party/blink/public/platform/resource_request_blocked_reason.h"
#include "third_party/blink/public/platform/web_url_request_extra_data.h"
#include "third_party/blink/renderer/platform/loader/fetch/render_blocking_behavior.h"
#include "third_party/blink/renderer/platform/loader/fetch/resource_load_priority.h"
#include "third_party/blink/renderer/platform/network/http_header_map.h"
#include "third_party/blink/renderer/platform/network/http_names.h"
#include "third_party/blink/renderer/platform/network/http_parsers.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
#include "third_party/blink/renderer/platform/weborigin/security_origin.h"
#include "third_party/blink/renderer/platform/wtf/ref_counted.h"
namespace network {
class PermissionsPolicy;
} // namespace network
namespace blink {
class FeatureContext;
class EncodedFormData;
struct IntegrityMetadataSet;
// ResourceRequestHead represents request without request body.
// See ResourceRequest below to see what request is.
// ResourceRequestHead is implicitly copyable while ResourceRequest is not.
// TODO(yoichio) : Migrate existing ResourceRequest occurrence not using request
// body to ResourceRequestHead.
class PLATFORM_EXPORT ResourceRequestHead {
DISALLOW_NEW();
public:
// TODO: Remove this enum from here since it is not used in this class anymore
enum class RedirectStatus : uint8_t { kFollowedRedirect, kNoRedirect };
struct RedirectInfo {
// Original (first) url in the redirect chain.
KURL original_url;
// Previous url in the redirect chain.
KURL previous_url;
RedirectInfo() = delete;
RedirectInfo(const KURL& original_url, const KURL& previous_url)
: original_url(original_url), previous_url(previous_url) {}
};
struct PLATFORM_EXPORT WebBundleTokenParams {
WebBundleTokenParams() = delete;
WebBundleTokenParams(const WebBundleTokenParams& other);
WebBundleTokenParams& operator=(const WebBundleTokenParams& other);
WebBundleTokenParams(
const KURL& bundle_url,
const base::UnguessableToken& token,
mojo::PendingRemote<network::mojom::blink::WebBundleHandle> handle);
mojo::PendingRemote<network::mojom::blink::WebBundleHandle> CloneHandle()
const;
KURL bundle_url;
base::UnguessableToken token;
mojo::PendingRemote<network::mojom::blink::WebBundleHandle> handle;
};
ResourceRequestHead();
explicit ResourceRequestHead(const KURL&);
ResourceRequestHead(const ResourceRequestHead&);
ResourceRequestHead& operator=(const ResourceRequestHead&);
ResourceRequestHead(ResourceRequestHead&&);
ResourceRequestHead& operator=(ResourceRequestHead&&);
~ResourceRequestHead();
// Constructs a new ResourceRequest for a redirect from this instance.
// Since body for a redirect request is kept and handled in the network
// service, the returned instance here in blink side doesn't contain body.
std::unique_ptr<ResourceRequest> CreateRedirectRequest(
const KURL& new_url,
const AtomicString& new_method,
const net::SiteForCookies& new_site_for_cookies,
const String& new_referrer,
network::mojom::ReferrerPolicy new_referrer_policy,
bool skip_service_worker) const;
bool IsNull() const;
const KURL& Url() const;
void SetUrl(const KURL&);
void RemoveUserAndPassFromURL();
mojom::blink::FetchCacheMode GetCacheMode() const;
void SetCacheMode(mojom::blink::FetchCacheMode);
base::TimeDelta TimeoutInterval() const;
void SetTimeoutInterval(base::TimeDelta);
const net::SiteForCookies& SiteForCookies() const;
void SetSiteForCookies(const net::SiteForCookies&);
// Returns true if SiteForCookies() was set either via SetSiteForCookies or
// CreateRedirectRequest.
bool SiteForCookiesSet() const { return site_for_cookies_set_; }
const SecurityOrigin* TopFrameOrigin() const;
void SetTopFrameOrigin(scoped_refptr<const SecurityOrigin>);
// The origin of the request, specified at
// https://fetch.spec.whatwg.org/#concept-request-origin. This origin can be
// null upon request, corresponding to the "client" value in the spec. In that
// case client's origin will be set when requesting. See
// ResourceFetcher::RequestResource.
const scoped_refptr<const SecurityOrigin>& RequestorOrigin() const {
return requestor_origin_;
}
void SetRequestorOrigin(scoped_refptr<const SecurityOrigin> origin) {
requestor_origin_ = std::move(origin);
}
// The chain of URLs seen during navigation redirects. This should only
// contain values if the mode is `RedirectMode::kNavigate`.
const WTF::Vector<KURL>& NavigationRedirectChain() const {
return navigation_redirect_chain_;
}
void SetNavigationRedirectChain(const WTF::Vector<KURL>& value) {
navigation_redirect_chain_ = value;
}
// The origin of the isolated world - set if this is a fetch/XHR initiated by
// an isolated world.
const scoped_refptr<const SecurityOrigin>& IsolatedWorldOrigin() const {
return isolated_world_origin_;
}
void SetIsolatedWorldOrigin(scoped_refptr<const SecurityOrigin> origin) {
isolated_world_origin_ = std::move(origin);
}
const AtomicString& HttpMethod() const;
void SetHttpMethod(const AtomicString&);
const HTTPHeaderMap& HttpHeaderFields() const;
const AtomicString& HttpHeaderField(const AtomicString& name) const;
void SetHttpHeaderField(const AtomicString& name, const AtomicString& value);
void AddHttpHeaderField(const AtomicString& name, const AtomicString& value);
void AddHTTPHeaderFields(const HTTPHeaderMap& header_fields);
void ClearHttpHeaderField(const AtomicString& name);
const AtomicString& HttpContentType() const {
return HttpHeaderField(http_names::kContentType);
}
void SetHTTPContentType(const AtomicString& http_content_type) {
SetHttpHeaderField(http_names::kContentType, http_content_type);
}
bool IsFormSubmission() const { return is_form_submission_; }
void SetFormSubmission(bool is_form_submission) {
is_form_submission_ = is_form_submission;
}
void SetReferrerPolicy(network::mojom::ReferrerPolicy referrer_policy) {
referrer_policy_ = referrer_policy;
}
network::mojom::ReferrerPolicy GetReferrerPolicy() const {
return referrer_policy_;
}
void SetReferrerString(const String& referrer_string) {
referrer_string_ = referrer_string;
}
const String& ReferrerString() const { return referrer_string_; }
const AtomicString& HttpOrigin() const {
return HttpHeaderField(http_names::kOrigin);
}
void SetHTTPOrigin(const SecurityOrigin*);
void ClearHTTPOrigin();
void SetHttpOriginIfNeeded(const SecurityOrigin*);
void SetHTTPOriginToMatchReferrerIfNeeded();
void SetHTTPUserAgent(const AtomicString& http_user_agent) {
SetHttpHeaderField(http_names::kUserAgent, http_user_agent);
}
void ClearHTTPUserAgent();
void SetHTTPAccept(const AtomicString& http_accept) {
SetHttpHeaderField(http_names::kAccept, http_accept);
}
// The initial priority for the request.
ResourceLoadPriority InitialPriority() const;
// The current priority for the request (in case it was changed).
ResourceLoadPriority Priority() const;
// Sub-priority for ordering requests at the same priority level.
// Used for visible images to load larger images before small.
int IntraPriorityValue() const;
bool PriorityHasBeenSet() const;
void SetPriority(ResourceLoadPriority, int intra_priority_value = 0);
bool IsConditional() const;
// Incremental property of HTTP Extensible Priorities which specifies that
// responses can be delivered concurrently if they are the same priority on
// a connection that supports multiplexing (HTTP/3 primarily).
// https://www.rfc-editor.org/rfc/rfc9218
bool PriorityIncremental() const;
void SetPriorityIncremental(bool);
// Whether the associated ResourceHandleClient needs to be notified of
// upload progress made for that resource.
bool ReportUploadProgress() const { return report_upload_progress_; }
void SetReportUploadProgress(bool report_upload_progress) {
report_upload_progress_ = report_upload_progress;
}
// True if request was user initiated.
bool HasUserGesture() const { return has_user_gesture_; }
void SetHasUserGesture(bool);
bool HasTextFragmentToken() const { return has_text_fragment_token_; }
void SetHasTextFragmentToken(bool);
// True if request shuold be downloaded to blob.
bool DownloadToBlob() const { return download_to_blob_; }
void SetDownloadToBlob(bool download_to_blob) {
download_to_blob_ = download_to_blob;
}
// True if the requestor wants to receive a response body as
// WebDataConsumerHandle.
bool UseStreamOnResponse() const { return use_stream_on_response_; }
void SetUseStreamOnResponse(bool use_stream_on_response) {
use_stream_on_response_ = use_stream_on_response;
}
// True if the request can work after the fetch group is terminated.
bool GetKeepalive() const { return keepalive_; }
void SetKeepalive(bool keepalive) {
keepalive_ = keepalive;
keepalive_token_ =
keepalive_ ? std::make_optional(base::UnguessableToken::Create())
: std::nullopt;
}
bool HasFetchRetryOptions() const { return fetch_retry_options_.has_value(); }
const std::optional<network::FetchRetryOptions>& FetchRetryOptions() const {
return fetch_retry_options_;
}
void SetFetchRetryOptions(
const network::FetchRetryOptions& fetch_retry_options) {
fetch_retry_options_ = fetch_retry_options;
}
// True if the request should be considered for computing and attaching the
// topics headers.
bool GetBrowsingTopics() const { return browsing_topics_; }
void SetBrowsingTopics(bool browsing_topics) {
browsing_topics_ = browsing_topics;
}
// True if this is an ad auction request eligible for attaching the
// `Sec-Ad-Auction-Fetch` request header and processing the
// `X-Ad-Auction-Result` response header.
bool GetAdAuctionHeaders() const { return ad_auction_headers_; }
void SetAdAuctionHeaders(bool ad_auction_headers) {
ad_auction_headers_ = ad_auction_headers;
}
// True if the original request included the required attribute for the
// response to be eligible to write to shared storage, pending a
// `PermissionsPolicy` check.
bool GetSharedStorageWritableOptedIn() const {
return shared_storage_writable_opted_in_;
}
void SetSharedStorageWritableOptedIn(bool shared_storage_writable_opted_in) {
shared_storage_writable_opted_in_ = shared_storage_writable_opted_in;
}
// True if the current request should have the
// `http_names::kSecSharedStorageWritable` header attached and is eligible to
// write to shared storage from response headers.
bool GetSharedStorageWritableEligible() const {
return shared_storage_writable_eligible_;
}
void SetSharedStorageWritableEligible(bool shared_storage_writable_eligible) {
shared_storage_writable_eligible_ = shared_storage_writable_eligible;
}
// True if service workers should not get events for the request.
bool GetSkipServiceWorker() const { return skip_service_worker_; }
void SetSkipServiceWorker(bool skip_service_worker) {
skip_service_worker_ = skip_service_worker;
}
// Extra data associated with this request.
const scoped_refptr<WebURLRequestExtraData>& GetURLRequestExtraData() const {
return url_request_extra_data_;
}
void SetURLRequestExtraData(
scoped_refptr<WebURLRequestExtraData> url_request_extra_data) {
url_request_extra_data_ = std::move(url_request_extra_data);
}
bool IsDownloadToNetworkCacheOnly() const { return download_to_cache_only_; }
void SetDownloadToNetworkCacheOnly(bool download_to_cache_only) {
download_to_cache_only_ = download_to_cache_only;
}
mojom::blink::RequestContextType GetRequestContext() const {
return request_context_;
}
void SetRequestContext(mojom::blink::RequestContextType context) {
request_context_ = context;
}
network::mojom::RequestDestination GetRequestDestination() const {
return destination_;
}
void SetRequestDestination(network::mojom::RequestDestination destination) {
destination_ = destination;
}
network::mojom::RequestMode GetMode() const { return mode_; }
void SetMode(network::mojom::RequestMode mode) { mode_ = mode; }
network::mojom::IPAddressSpace GetTargetAddressSpace() const {
return target_address_space_;
}
void SetTargetAddressSpace(
network::mojom::IPAddressSpace target_address_space) {
target_address_space_ = target_address_space;
}
// A resource request's fetch_priority_hint_ is a developer-set priority
// hint that differs from priority_. It is used in
// ResourceFetcher::ComputeLoadPriority to possibly influence the resolved
// priority of a resource request.
// This member exists both here and in FetchParameters, as opposed just in
// the latter because the fetch() API creates a ResourceRequest object long
// before its associaed FetchParameters, so this makes it easier to
// communicate a fetch_priority_hint value down to the lower-level fetching
// code.
mojom::blink::FetchPriorityHint GetFetchPriorityHint() const {
return fetch_priority_hint_;
}
void SetFetchPriorityHint(
mojom::blink::FetchPriorityHint fetch_priority_hint) {
fetch_priority_hint_ = fetch_priority_hint;
}
network::mojom::CredentialsMode GetCredentialsMode() const {
return credentials_mode_;
}
void SetCredentialsMode(network::mojom::CredentialsMode mode) {
credentials_mode_ = mode;
}
network::mojom::RedirectMode GetRedirectMode() const {
return redirect_mode_;
}
void SetRedirectMode(network::mojom::RedirectMode redirect) {
redirect_mode_ = redirect;
}
const String& GetFetchIntegrity() const { return fetch_integrity_; }
void SetFetchIntegrity(const String& integrity, const FeatureContext*);
// This is also called as a side-effect of `SetFetchIntegrity()`.
void SetExpectedPublicKeys(const IntegrityMetadataSet&);
const WTF::Vector<String>& GetExpectedPublicKeys() const {
return expected_public_keys_;
}
bool CacheControlContainsNoCache() const;
bool CacheControlContainsNoStore() const;
bool HasCacheValidatorFields() const;
network::mojom::CorsPreflightPolicy CorsPreflightPolicy() const {
return cors_preflight_policy_;
}
void SetCorsPreflightPolicy(network::mojom::CorsPreflightPolicy policy) {
cors_preflight_policy_ = policy;
}
const std::optional<RedirectInfo>& GetRedirectInfo() const {
return redirect_info_;
}
void SetSuggestedFilename(const std::optional<String>& suggested_filename) {
suggested_filename_ = suggested_filename;
}
const std::optional<String>& GetSuggestedFilename() const {
return suggested_filename_;
}
void SetIsAdResource() { is_ad_resource_ = true; }
bool IsAdResource() const { return is_ad_resource_; }
void SetUpgradeIfInsecure(bool upgrade_if_insecure) {
upgrade_if_insecure_ = upgrade_if_insecure;
}
bool UpgradeIfInsecure() const { return upgrade_if_insecure_; }
bool IsRevalidating() const { return is_revalidating_; }
void SetIsRevalidating(bool value) { is_revalidating_ = value; }
void SetIsAutomaticUpgrade(bool is_automatic_upgrade) {
is_automatic_upgrade_ = is_automatic_upgrade;
}
bool IsAutomaticUpgrade() const { return is_automatic_upgrade_; }
void SetAllowStaleResponse(bool value) { allow_stale_response_ = value; }
bool AllowsStaleResponse() const { return allow_stale_response_; }
const std::optional<base::UnguessableToken>& GetDevToolsToken() const {
return devtools_token_;
}
void SetDevToolsToken(
const std::optional<base::UnguessableToken>& devtools_token) {
devtools_token_ = devtools_token;
}
const scoped_refptr<
base::RefCountedData<base::flat_set<net::SourceStreamType>>>&
GetDevToolsAcceptedStreamTypes() const {
return devtools_accepted_stream_types_;
}
void SetDevToolsAcceptedStreamTypes(
const scoped_refptr<
base::RefCountedData<base::flat_set<net::SourceStreamType>>>& types) {
devtools_accepted_stream_types_ = types;
}
const String& GetDevToolsId() const { return devtools_id_; }
void SetDevToolsId(const String devtools_id) { devtools_id_ = devtools_id; }
void SetRequestedWithHeader(const String& value) {
requested_with_header_ = value;
}
const String& GetRequestedWithHeader() const {
return requested_with_header_;
}
void SetClientDataHeader(const String& value) { client_data_header_ = value; }
const String& GetClientDataHeader() const { return client_data_header_; }
void SetPurposeHeader(const String& value) { purpose_header_ = value; }
const String& GetPurposeHeader() const { return purpose_header_; }
// A V8 stack id string describing where the request was initiated. DevTools
// can use this to display the initiator call stack when debugging a process
// that later intercepts the request, e.g., in a service worker fetch event
// handler.
const std::optional<String>& GetDevToolsStackId() const {
return devtools_stack_id_;
}
void SetDevToolsStackId(const std::optional<String>& devtools_stack_id) {
devtools_stack_id_ = devtools_stack_id;
}
void SetUkmSourceId(ukm::SourceId ukm_source_id) {
ukm_source_id_ = ukm_source_id;
}
ukm::SourceId GetUkmSourceId() const { return ukm_source_id_; }
// https://fetch.spec.whatwg.org/#concept-request-window
// See network::ResourceRequest::fetch_window_id for details.
void SetFetchWindowId(const base::UnguessableToken& id) {
fetch_window_id_ = id;
}
const base::UnguessableToken& GetFetchWindowId() const {
return fetch_window_id_;
}
void SetRecursivePrefetchToken(
const std::optional<base::UnguessableToken>& token) {
recursive_prefetch_token_ = token;
}
const std::optional<base::UnguessableToken>& RecursivePrefetchToken() const {
return recursive_prefetch_token_;
}
void SetInspectorId(uint64_t inspector_id) { inspector_id_ = inspector_id; }
uint64_t InspectorId() const { return inspector_id_; }
bool IsFromOriginDirtyStyleSheet() const {
return is_from_origin_dirty_style_sheet_;
}
void SetFromOriginDirtyStyleSheet(bool dirty) {
is_from_origin_dirty_style_sheet_ = dirty;
}
bool IsFetchLikeAPI() const { return is_fetch_like_api_; }
void SetFetchLikeAPI(bool enabled) { is_fetch_like_api_ = enabled; }
bool IsFetchLaterAPI() const { return is_fetch_later_api_; }
void SetFetchLaterAPI(bool enabled) { is_fetch_later_api_ = enabled; }
bool IsFavicon() const { return is_favicon_; }
void SetFavicon(bool enabled) { is_favicon_ = enabled; }
bool PrefetchMaybeForTopLevelNavigation() const {
return prefetch_maybe_for_top_level_navigation_;
}
void SetPrefetchMaybeForTopLevelNavigation(
bool prefetch_maybe_for_top_level_navigation) {
prefetch_maybe_for_top_level_navigation_ =
prefetch_maybe_for_top_level_navigation;
}
const std::optional<network::mojom::blink::TrustTokenParams>&
TrustTokenParams() const {
return trust_token_params_;
}
void SetTrustTokenParams(
std::optional<network::mojom::blink::TrustTokenParams> params) {
trust_token_params_ = std::move(params);
}
// Whether either RequestorOrigin or IsolatedWorldOrigin can display the
// |url|,
bool CanDisplay(const KURL&) const;
// The original destination of a request passed through by a service worker.
network::mojom::RequestDestination GetOriginalDestination() const {
return original_destination_;
}
void SetOriginalDestination(network::mojom::RequestDestination value) {
original_destination_ = value;
}
const std::optional<ResourceRequestHead::WebBundleTokenParams>&
GetWebBundleTokenParams() const {
return web_bundle_token_params_;
}
void SetWebBundleTokenParams(
ResourceRequestHead::WebBundleTokenParams params) {
web_bundle_token_params_ = params;
}
void SetRenderBlockingBehavior(RenderBlockingBehavior behavior) {
render_blocking_behavior_ = behavior;
}
RenderBlockingBehavior GetRenderBlockingBehavior() const {
return render_blocking_behavior_;
}
void SetStorageAccessApiStatus(net::StorageAccessApiStatus status) {
storage_access_api_status_ = status;
}
net::StorageAccessApiStatus GetStorageAccessApiStatus() const {
return storage_access_api_status_;
}
network::mojom::AttributionSupport GetAttributionReportingSupport() const {
return attribution_reporting_support_;
}
void SetAttributionReportingSupport(
network::mojom::AttributionSupport attribution_support) {
attribution_reporting_support_ = attribution_support;
}
network::mojom::AttributionReportingEligibility
GetAttributionReportingEligibility() const {
return attribution_reporting_eligibility_;
}
void SetAttributionReportingEligibility(
network::mojom::AttributionReportingEligibility eligibility) {
attribution_reporting_eligibility_ = eligibility;
}
const std::optional<base::UnguessableToken>& GetAttributionSrcToken() const {
return attribution_reporting_src_token_;
}
void SetAttributionReportingSrcToken(
std::optional<base::UnguessableToken> src_token) {
attribution_reporting_src_token_ = src_token;
}
bool SharedDictionaryWriterEnabled() const {
return shared_dictionary_writer_enabled_;
}
void SetSharedDictionaryWriterEnabled(bool shared_dictionary_writer_enabled) {
shared_dictionary_writer_enabled_ = shared_dictionary_writer_enabled;
}
const std::optional<base::UnguessableToken>&
GetServiceWorkerRaceNetworkRequestToken() const {
return service_worker_race_network_request_token_;
}
void SetServiceWorkerRaceNetworkRequestToken(
const base::UnguessableToken& token) {
// TODO(crbug.com/1492640) Consider using base::TokenType not to include
// null token by strong typing.
if (token.is_empty()) {
return;
}
service_worker_race_network_request_token_ = token;
}
void SetKnownTransparentPlaceholderImageIndex(wtf_size_t index) {
known_transparent_placeholder_image_index_ = index;
}
// TODO(crbug.com/41496436): Make the optimizations referencing the index
// applicable to all static resource loads.
wtf_size_t GetKnownTransparentPlaceholderImageIndex() const {
return known_transparent_placeholder_image_index_;
}
const std::optional<base::UnguessableToken>& GetKeepaliveToken() const {
return keepalive_token_;
}
// Indicates that both FetchContext::PrepareResourceRequestForCacheAccess()
// and FetchContext::UpgradeResourceRequestForLoader() must be called. See
// FetchContext::UpgradeResourceRequestForLoader() for details.
void SetRequiresUpgradeForLoader() { requires_upgrade_for_loader_ = true; }
bool RequiresUpgradeForLoader() const { return requires_upgrade_for_loader_; }
// See comment in SetUrl().
void SetCanChangeUrl(bool value) {
#if DCHECK_IS_ON()
is_set_url_allowed_ = value;
#endif
}
bool AllowsDeviceBoundSessionRegistration() const {
return allows_device_bound_session_registration_;
}
void SetAllowsDeviceBoundSessionRegistration(
bool allows_device_bound_session_registration) {
allows_device_bound_session_registration_ =
allows_device_bound_session_registration;
}
private:
const CacheControlHeader& GetCacheControlHeader() const;
bool NeedsHTTPOrigin() const;
KURL url_;
// base::TimeDelta::Max() represents the default timeout on platforms that
// have one.
base::TimeDelta timeout_interval_;
net::SiteForCookies site_for_cookies_;
scoped_refptr<const SecurityOrigin> top_frame_origin_;
scoped_refptr<const SecurityOrigin> requestor_origin_;
WTF::Vector<KURL> navigation_redirect_chain_;
scoped_refptr<const SecurityOrigin> isolated_world_origin_;
AtomicString http_method_;
HTTPHeaderMap http_header_fields_;
bool report_upload_progress_ : 1;
bool has_user_gesture_ : 1;
bool has_text_fragment_token_ : 1;
bool download_to_blob_ : 1;
bool use_stream_on_response_ : 1;
bool keepalive_ : 1;
bool browsing_topics_ : 1;
bool ad_auction_headers_ : 1;
bool shared_storage_writable_opted_in_ : 1;
bool shared_storage_writable_eligible_ : 1;
bool allow_stale_response_ : 1;
bool skip_service_worker_ : 1;
bool download_to_cache_only_ : 1;
bool site_for_cookies_set_ : 1;
bool is_form_submission_ : 1;
bool priority_incremental_ : 1;
bool is_ad_resource_ : 1;
bool upgrade_if_insecure_ : 1;
bool is_revalidating_ : 1;
bool is_automatic_upgrade_ : 1;
bool is_from_origin_dirty_style_sheet_ : 1;
bool is_fetch_like_api_ : 1;
// Indicates that this ResourceRequest represents the requestObject for a
// JS fetchLater() call.
// https://whatpr.org/fetch/1647/094ea69...152d725.html#fetch-later-method
bool is_fetch_later_api_ : 1;
bool is_favicon_ : 1;
// Currently this is only used when a prefetch request has `as=document`
// specified. If true, and the request is cross-origin, the browser will cache
// the request under the cross-origin's partition. Furthermore, its reuse from
// the prefetch cache will be restricted to top-level-navigations.
bool prefetch_maybe_for_top_level_navigation_ : 1;
// Indicate the state of CompressionDictionaryTransport feature. When it is
// true, `use-as-dictionary` response HTTP header may be processed.
// TODO(crbug.com/1413922): Remove this flag when we launch
// CompressionDictionaryTransport feature.
bool shared_dictionary_writer_enabled_ : 1;
bool requires_upgrade_for_loader_ : 1;
mojom::blink::FetchCacheMode cache_mode_;
ResourceLoadPriority initial_priority_;
ResourceLoadPriority priority_;
int intra_priority_value_;
scoped_refptr<WebURLRequestExtraData> url_request_extra_data_;
mojom::blink::RequestContextType request_context_;
network::mojom::RequestDestination destination_;
network::mojom::RequestMode mode_;
mojom::blink::FetchPriorityHint fetch_priority_hint_;
network::mojom::CredentialsMode credentials_mode_;
network::mojom::RedirectMode redirect_mode_;
// Exposed as Request.integrity in Service Workers
String fetch_integrity_;
// Public key expectations extracted from `integrity_`
WTF::Vector<String> expected_public_keys_;
String referrer_string_;
network::mojom::ReferrerPolicy referrer_policy_;
network::mojom::CorsPreflightPolicy cors_preflight_policy_;
std::optional<RedirectInfo> redirect_info_;
std::optional<network::mojom::blink::TrustTokenParams> trust_token_params_;
network::mojom::IPAddressSpace target_address_space_;
std::optional<String> suggested_filename_;
mutable CacheControlHeader cache_control_header_cache_;
static const base::TimeDelta default_timeout_interval_;
std::optional<base::UnguessableToken> devtools_token_;
String devtools_id_;
String requested_with_header_;
String client_data_header_;
String purpose_header_;
std::optional<String> devtools_stack_id_;
ukm::SourceId ukm_source_id_ = ukm::kInvalidSourceId;
base::UnguessableToken fetch_window_id_;
network::mojom::RequestDestination original_destination_ =
network::mojom::RequestDestination::kEmpty;
uint64_t inspector_id_ = 0;
// This is used when fetching preload header requests from cross-origin
// prefetch responses. The browser process uses this token to ensure the
// request is cached correctly.
std::optional<base::UnguessableToken> recursive_prefetch_token_;
// This is used when fetching either a WebBundle or a subresrouce in the
// WebBundle. The network process uses this token to associate the request to
// the bundle.
std::optional<WebBundleTokenParams> web_bundle_token_params_;
// Render blocking behavior of the resource. Used in maintaining correct
// reporting for redirects.
RenderBlockingBehavior render_blocking_behavior_ =
RenderBlockingBehavior::kUnset;
// If not null, the network service will not advertise any stream types
// (via Accept-Encoding) that are not listed. Also, it will not attempt
// decoding any non-listed stream types.
// Instead of using std::optional, we use scoped_refptr to reduce
// blink memory footprint because the attribute is only used by DevTools
// and we should keep the footprint minimal when DevTools is closed.
scoped_refptr<base::RefCountedData<base::flat_set<net::SourceStreamType>>>
devtools_accepted_stream_types_;
net::StorageAccessApiStatus storage_access_api_status_ =
net::StorageAccessApiStatus::kNone;
network::mojom::AttributionSupport attribution_reporting_support_ =
network::mojom::AttributionSupport::kUnset;
network::mojom::AttributionReportingEligibility
attribution_reporting_eligibility_ =
network::mojom::AttributionReportingEligibility::kUnset;
std::optional<base::UnguessableToken> attribution_reporting_src_token_;
// The request is for a known transparent placeholder image, which enables us
// to bypass as much processing as possible.
// TODO(crbug.com/41496436): Make all the optimizations referencing the flag
// applicable to all static resource load.
wtf_size_t known_transparent_placeholder_image_index_ = kNotFound;
std::optional<base::UnguessableToken>
service_worker_race_network_request_token_;
// The unique identifier set when this request's `keepalive_` is true.
// TODO(crbug.com/382527001): Consider merge this field with `keepalive_`.
std::optional<base::UnguessableToken> keepalive_token_;
std::optional<network::FetchRetryOptions> fetch_retry_options_;
#if DCHECK_IS_ON()
bool is_set_url_allowed_ = true;
#endif
// Whether this request is allowed to register new device bound
// sessions or accept challenges on device bound sessions (e.g. due to
// an Origin Trial)
bool allows_device_bound_session_registration_ = false;
};
class PLATFORM_EXPORT ResourceRequestBody {
public:
ResourceRequestBody();
explicit ResourceRequestBody(scoped_refptr<EncodedFormData> form_body);
explicit ResourceRequestBody(
mojo::PendingRemote<network::mojom::blink::ChunkedDataPipeGetter>
stream_body);
ResourceRequestBody(const ResourceRequestBody&) = delete;
ResourceRequestBody(ResourceRequestBody&&);
ResourceRequestBody& operator=(const ResourceRequestBody&) = delete;
ResourceRequestBody& operator=(ResourceRequestBody&&);
~ResourceRequestBody();
bool IsEmpty() const { return !form_body_ && !stream_body_; }
const scoped_refptr<EncodedFormData>& FormBody() const { return form_body_; }
void SetFormBody(scoped_refptr<EncodedFormData>);
mojo::PendingRemote<network::mojom::blink::ChunkedDataPipeGetter>
TakeStreamBody() {
return std::move(stream_body_);
}
const mojo::PendingRemote<network::mojom::blink::ChunkedDataPipeGetter>&
StreamBody() const {
return stream_body_;
}
void SetStreamBody(
mojo::PendingRemote<network::mojom::blink::ChunkedDataPipeGetter>);
private:
scoped_refptr<EncodedFormData> form_body_;
mojo::PendingRemote<network::mojom::blink::ChunkedDataPipeGetter>
stream_body_;
};
// A ResourceRequest is a "request" object for ResourceLoader. Conceptually
// it is https://fetch.spec.whatwg.org/#concept-request, but it contains
// a lot of blink specific fields. WebURLRequest is the "public version"
// of this class and URLLoader needs it. See WebURLRequest and
// WrappedResourceRequest.
//
// This class is thread-bound. Do not copy/pass an instance across threads.
//
// Although request consists head and body, ResourceRequest is implemented by
// inheriting ResourceRequestHead in order to make it possible to use
// property accessors through both ResourceRequestHead and ResourceRequest while
// avoiding duplicate accessor definitions.
// For those who want to add a new property in request, please implement its
// member and accessors in ResourceRequestHead instead of ResourceRequest.
class PLATFORM_EXPORT ResourceRequest final : public ResourceRequestHead {
USING_FAST_MALLOC(ResourceRequest);
public:
ResourceRequest();
explicit ResourceRequest(const String& url_string);
explicit ResourceRequest(const KURL&);
explicit ResourceRequest(const ResourceRequestHead&);
ResourceRequest(const ResourceRequest&) = delete;
ResourceRequest(ResourceRequest&&);
ResourceRequest& operator=(const ResourceRequest&) = delete;
ResourceRequest& operator=(ResourceRequest&&);
~ResourceRequest();
void CopyHeadFrom(const ResourceRequestHead&);
const scoped_refptr<EncodedFormData>& HttpBody() const;
void SetHttpBody(scoped_refptr<EncodedFormData>);
ResourceRequestBody& MutableBody() { return body_; }
// `PermissionsPolicy` is in blink/public and hence cannot access
// `ResourceRequest`. We implement this method here and make `ResourceRequest`
// a forward-declared friend class to `PermissionsPolicy` in order to keep
// `PermissionsPolicy::IsFeatureEnabledForSubresourceRequestAssumingOptIn()`
// private for safety.
bool IsFeatureEnabledForSubresourceRequestAssumingOptIn(
const network::PermissionsPolicy* policy,
network::mojom::PermissionsPolicyFeature feature,
const url::Origin& origin);
private:
ResourceRequestBody body_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_PLATFORM_LOADER_FETCH_RESOURCE_REQUEST_H_
|