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 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
|
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_CONTROLLER_IMPL_H_
#define CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_CONTROLLER_IMPL_H_
#include <stddef.h>
#include <stdint.h>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include "base/functional/callback.h"
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/raw_ref.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "build/build_config.h"
#include "content/browser/renderer_host/back_forward_cache_impl.h"
#include "content/browser/renderer_host/navigation_controller_delegate.h"
#include "content/browser/renderer_host/navigation_entry_impl.h"
#include "content/browser/renderer_host/navigation_type.h"
#include "content/browser/ssl/ssl_manager.h"
#include "content/common/content_export.h"
#include "content/common/navigation_client.mojom-forward.h"
#include "content/public/browser/navigation_controller.h"
#include "content/public/browser/reload_type.h"
#include "mojo/public/cpp/bindings/pending_associated_remote.h"
#include "net/storage_access_api/status.h"
#include "services/network/public/mojom/source_location.mojom-forward.h"
#include "third_party/blink/public/common/scheduler/task_attribution_id.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/blink/public/mojom/navigation/navigation_api_history_entry_arrays.mojom-forward.h"
#include "third_party/blink/public/mojom/navigation/navigation_initiator_activation_and_ad_status.mojom.h"
#include "third_party/blink/public/mojom/navigation/navigation_params.mojom-forward.h"
namespace blink {
struct NavigationDownloadPolicy;
} // namespace blink
namespace content {
class FrameTree;
class FrameTreeNode;
class NavigationEntryScreenshotCache;
class NavigationRequest;
class RenderFrameHostImpl;
class SiteInstance;
struct LoadCommittedDetails;
// NavigationControllerImpl is 1:1 with FrameTree. See comments on the base
// class.
class CONTENT_EXPORT NavigationControllerImpl : public NavigationController {
public:
// This tracks one NavigationRequest navigating to a pending NavigationEntry.
// In some cases, several NavigationRequests are referencing the same pending
// NavigationEntry. For instance:
// - A reload requested while a reload is already in progress.
// - An history navigation causing several subframes to navigate.
//
// When no NavigationRequests are referencing the pending NavigationEntry
// anymore, it should be discarded to avoid a URL spoof.
//
// The deletion is not always immediate, because it is not possible to delete
// the entry while requesting a navigation to it at the same time. In this
// case, the deletion happens later, when returning from the function.
//
// If the pending NavigationEntry is discarded before the PendingEntryRef(s),
// then removing the last associated PendingEntryRef is a no-op. It is a no-op
// forever, even if the entry becomes the pending NavigationEntry again in the
// meantime. Rather than track the NavigationRequest or pending entry
// explicitly, this ref class simply goes into a set that gets cleared with
// each change to the pending entry
class PendingEntryRef {
public:
explicit PendingEntryRef(
base::WeakPtr<NavigationControllerImpl> controller);
PendingEntryRef(const PendingEntryRef&) = delete;
PendingEntryRef& operator=(const PendingEntryRef&) = delete;
~PendingEntryRef();
private:
base::WeakPtr<NavigationControllerImpl> controller_;
};
NavigationControllerImpl(BrowserContext* browser_context,
FrameTree& frame_tree,
NavigationControllerDelegate* delegate);
NavigationControllerImpl(const NavigationControllerImpl&) = delete;
NavigationControllerImpl& operator=(const NavigationControllerImpl&) = delete;
~NavigationControllerImpl() override;
// NavigationController implementation:
BrowserContext* GetBrowserContext() override;
void Restore(int selected_navigation,
RestoreType type,
std::vector<std::unique_ptr<NavigationEntry>>* entries) override;
NavigationEntryImpl* GetActiveEntry() override;
NavigationEntryImpl* GetVisibleEntry() override;
int GetCurrentEntryIndex() override;
NavigationEntryImpl* GetLastCommittedEntry() override;
const NavigationEntryImpl* GetLastCommittedEntry() const override;
int GetLastCommittedEntryIndex() override;
bool CanViewSource() override;
int GetEntryCount() override;
NavigationEntryImpl* GetEntryAtIndex(int index) override;
NavigationEntryImpl* GetEntryAtOffset(int offset) override;
void DiscardNonCommittedEntries() override;
NavigationEntryImpl* GetPendingEntry() override;
int GetPendingEntryIndex() override;
base::WeakPtr<NavigationHandle> LoadURL(
const GURL& url,
const Referrer& referrer,
ui::PageTransition type,
const std::string& extra_headers) override;
base::WeakPtr<NavigationHandle> LoadURLWithParams(
const LoadURLParams& params) override;
void LoadIfNecessary() override;
void LoadOriginalRequestURL() override;
base::WeakPtr<NavigationHandle> LoadPostCommitErrorPage(
RenderFrameHost* render_frame_host,
const GURL& url,
const std::string& error_page_html) override;
bool CanGoBack() override;
bool CanGoForward() override;
bool CanGoToOffset(int offset) override;
WeakNavigationHandleVector GoBack() override;
WeakNavigationHandleVector GoForward() override;
WeakNavigationHandleVector GoToIndex(int index) override;
void GoToOffset(int offset) override;
bool RemoveEntryAtIndex(int index) override;
void PruneForwardEntries() override;
const SessionStorageNamespaceMap& GetSessionStorageNamespaceMap() override;
SessionStorageNamespace* GetDefaultSessionStorageNamespace() override;
bool NeedsReload() override;
void SetNeedsReload() override;
void CancelPendingReload() override;
void ContinuePendingReload() override;
bool IsInitialNavigation() override;
bool IsInitialBlankNavigation() override;
void Reload(ReloadType reload_type, bool check_for_repost) override;
void NotifyEntryChanged(NavigationEntry* entry) override;
void CopyStateFrom(NavigationController* source, bool needs_reload) override;
bool CanPruneAllButLastCommitted() override;
void PruneAllButLastCommitted() override;
void DeleteNavigationEntries(
const DeletionPredicate& deletionPredicate) override;
BackForwardCacheImpl& GetBackForwardCache() override;
// Discards the pending entry if any. If this is caused by a navigation
// committing a new entry, `commit_details` will contain the committed
// navigation's details.
void DiscardNonCommittedEntriesWithCommitDetails(
LoadCommittedDetails* commit_details);
// Creates the initial NavigationEntry for the NavigationController when its
// FrameTree is being initialized. See NavigationEntry::IsInitialEntry() on
// what this means.
void CreateInitialEntry();
// Gets the `NavigationEntryScreenshotCache` for this `NavigationController`.
// Due to MPArch there can be multiple `FrameTree`s within a single tab. This
// should only be called for the primary FrameTree. This cache is
// lazy-initialized when this method is first called.
NavigationEntryScreenshotCache* GetNavigationEntryScreenshotCache();
// Starts a navigation in a newly created subframe as part of a history
// navigation. Returns true if the history navigation could start, false
// otherwise. If this returns false, the caller should do a regular
// navigation to the default src URL for the frame instead.
bool StartHistoryNavigationInNewSubframe(
RenderFrameHostImpl* render_frame_host,
mojo::PendingAssociatedRemote<mojom::NavigationClient>* navigation_client,
blink::LocalFrameToken initiator_frame_token,
int initiator_process_id,
base::TimeTicks actual_navigation_start);
// Reloads the |frame_tree_node| and returns true. In some rare cases, there
// is no history related to the frame, nothing happens and this returns false.
bool ReloadFrame(FrameTreeNode* frame_tree_node);
// Navigates to the specified offset from the "current entry" and marks the
// navigations as initiated by the renderer.
// |initiator_rfh| is the frame that requested the navigation.
// |soft_navigation_heuristics_task_id| is the task in the renderer that
// initiated this call (if any).
// |actual_navigation_start| is the time the navigation began, for metrics.
void GoToOffsetFromRenderer(int offset,
RenderFrameHostImpl* initiator_rfh,
std::optional<blink::scheduler::TaskAttributionId>
soft_navigation_heuristics_task_id,
base::TimeTicks actual_navigation_start);
// A variation of `NavigationController::GoToIndex()`, that also returns all
// the created `NavigationRequest`s. If no navigation request is created, the
// vector is empty.
std::vector<base::WeakPtr<NavigationRequest>> GoToIndexAndReturnAllRequests(
int index);
#if BUILDFLAG(IS_ANDROID)
// The difference between (Can)GoToOffsetWithSkipping and
// (Can)GoToOffset/(Can)GoToOffsetInSandboxedFrame is that this respects the
// history manipulation intervention and will exclude skippable entries.
// These should only be used for browser-initiated navigaitons.
bool CanGoToOffsetWithSkipping(int offset);
void GoToOffsetWithSkipping(int offset);
#endif
// Called when a document requests a navigation through a
// RenderFrameProxyHost.
void NavigateFromFrameProxy(
RenderFrameHostImpl* render_frame_host,
const GURL& url,
const blink::LocalFrameToken* initiator_frame_token,
int initiator_process_id,
const std::optional<url::Origin>& initiator_origin,
const std::optional<GURL>& initiator_base_url,
bool is_renderer_initiated,
SiteInstance* source_site_instance,
const Referrer& referrer,
ui::PageTransition page_transition,
bool should_replace_current_entry,
blink::NavigationDownloadPolicy download_policy,
const std::string& method,
scoped_refptr<network::ResourceRequestBody> post_body,
const std::string& extra_headers,
network::mojom::SourceLocationPtr source_location,
scoped_refptr<network::SharedURLLoaderFactory> blob_url_loader_factory,
bool is_form_submission,
const std::optional<blink::Impression>& impression,
blink::mojom::NavigationInitiatorActivationAndAdStatus
initiator_activation_and_ad_status,
base::TimeTicks actual_navigation_start_time,
base::TimeTicks navigation_start_time,
bool is_embedder_initiated_fenced_frame_navigation = false,
bool is_unfenced_top_navigation = false,
bool force_new_browsing_instance = false,
bool is_container_initiated = false,
bool has_rel_opener = false,
net::StorageAccessApiStatus storage_access_api_status =
net::StorageAccessApiStatus::kNone,
std::optional<std::u16string> embedder_shared_storage_context =
std::nullopt);
// Navigates to the history entry associated with the given navigation API
// |key|. Searches |entries_| for a FrameNavigationEntry associated with
// |initiator_rfh|'s FrameTreeNode that has |key| as its navigation API key.
// Searches back from the current index, then forward, so if there are
// multiple entries with the same key, the nearest to current should be
// selected. Stops searching in the current direction if it finds a
// NavigationEntry without a FrameNavigationEntry for |initiator_rfh|'s
// FrameTreeNode, or if the FrameNavigationEntry doesn't match origin or site
// instance.
//
// If no matching entry is found, the navigation is dropped. The renderer
// should only send the navigation to the browser if it believes the entry is
// in |entries_|, but it might be wrong (if the entry was dropped from
// |entries_|, or due to a race condition) or compromised.
// If a matching entry is found, navigate to that entry and proceed like any
// other history navigation.
// |soft_navigation_heuristics_task_id|: The task in the renderer that
// initiated this call (if any).
// |actual_navigation_start| is the time the navigation began, for metrics.
void NavigateToNavigationApiKey(
RenderFrameHostImpl* initiator_rfh,
std::optional<blink::scheduler::TaskAttributionId>
soft_navigation_heuristics_task_id,
const std::string& key,
base::TimeTicks actual_navigation_start);
// Whether this is the initial navigation in an unmodified new tab. In this
// case, we know there is no content displayed in the page.
bool IsUnmodifiedBlankTab();
// The session storage namespace that all child `blink::WebView`s associated
// with `partition_config` should use.
SessionStorageNamespace* GetSessionStorageNamespace(
const StoragePartitionConfig& partition_config);
// Returns the index of the specified entry, or -1 if entry is not contained
// in this NavigationController.
int GetIndexOfEntry(const NavigationEntryImpl* entry) const;
// Return the index of the entry with the given unique id, or -1 if not found.
int GetEntryIndexWithUniqueID(int nav_entry_id) const;
// Returns the index that would be used by `GoBack`. This respects skippable
// entries. Returns nullopt if no unskippable back entry exists.
std::optional<int> GetIndexForGoBack();
// Returns the index that would be used by `GoForward`. This respects
// skippable entries. Returns nullopt if no forward entry exists.
std::optional<int> GetIndexForGoForward();
// Return the entry with the given unique id, or null if not found.
NavigationEntryImpl* GetEntryWithUniqueID(int nav_entry_id) const;
// Same as above method, but also includes the pending entry in the search
// space.
NavigationEntryImpl* GetEntryWithUniqueIDIncludingPending(
int nav_entry_id) const;
NavigationControllerDelegate* delegate() const { return delegate_; }
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class NeedsReloadType {
kRequestedByClient = 0,
kRestoreSession = 1,
kCopyStateFrom = 2,
kCrashedSubframe = 3,
kMaxValue = kCrashedSubframe
};
// Request a reload to happen when activated. Same as the public
// SetNeedsReload(), but takes in a |type| which specifies why the reload is
// being requested.
void SetNeedsReload(NeedsReloadType type);
// Navigates directly to an error page in response to an event on the last
// committed page, with |error_page_html| as the contents and |url| as the
// URL. Permanently replaces the current session history item for that frame
// with a new one reflecting the error page navigation. The error navigation
// is not "sticky", meaning that if the frame is reloaded, it will attempt to
// load |url| normally.
//
// You should almost always prefer this function to
// |LoadPostCommitErrorPage()|, which only temporarily replaces the
// NavigationEntry. See |NavigationController::LoadPostCommitErrorPage()| for
// more details on this temporary replacement.
//
// IMPORTANT: This function will CHECK if |render_frame_host_impl| is not a
// fenced frame root, but in the future it will be updated to work for any
// frame. TODO(crbug.com/406729265): Implement this method for all types of
// frames, including main frames and other subframe types.
virtual void NavigateFrameToErrorPage(
RenderFrameHostImpl* render_frame_host_impl,
const GURL& url,
const std::string& error_page_html);
// For use by WebContentsImpl ------------------------------------------------
// Visit all FrameNavigationEntries as well as all frame trees and register
// any instances of |origin| as having the default isolation state with their
// respective BrowsingInstances. This is important when |origin| is seen with
// an OriginAgentCluster header, so that we only accept such requests in
// BrowsingInstances that haven't seen it before.
void RegisterExistingOriginAsHavingDefaultIsolation(
const url::Origin& origin);
// Allow renderer-initiated navigations to create a pending entry when the
// provisional load starts.
void SetPendingEntry(std::unique_ptr<NavigationEntryImpl> entry);
// Handles updating the navigation state after the renderer has navigated.
// This is used by the WebContentsImpl.
//
// If a new entry is created, it will return true and will have filled the
// given details structure and broadcast the NOTIFY_NAV_ENTRY_COMMITTED
// notification. The caller can then use the details without worrying about
// listening for the notification.
//
// In the case that nothing has changed, the details structure is undefined
// and it will return false.
//
// |was_on_initial_empty_document| indicates whether the document being
// navigated away from was an initial empty document.
//
// |previous_document_had_history_intervention_activation| is true if the
// previous document had a user activation that is being honored for the
// history manipulation intervention (i.e., a new user activation is needed
// after same-document back/forward navigations).
// See RFHI::honor_sticky_activation_for_history_intervention_ for details.
// This is used for a new renderer-initiated navigation to decide if the page
// that initiated the navigation should be skipped on back/forward button.
bool RendererDidNavigate(
RenderFrameHostImpl* rfh,
const mojom::DidCommitProvisionalLoadParams& params,
LoadCommittedDetails* details,
bool is_same_document_navigation,
bool was_on_initial_empty_document,
bool previous_document_had_history_intervention_activation,
NavigationRequest* navigation_request);
// Notifies us that we just became active. This is used by the WebContentsImpl
// so that we know to load URLs that were pending as "lazy" loads.
void SetActive(bool is_active);
// Sets the SessionStorageNamespace for the given |partition_config|. This is
// used during initialization of a new NavigationController to allow
// pre-population of the SessionStorageNamespace objects. Session restore,
// prerendering, and the implementation of window.open() are the primary users
// of this API.
//
// Calling this function when a SessionStorageNamespace has already been
// associated with a |partition_id| will CHECK() fail.
void SetSessionStorageNamespace(
const StoragePartitionConfig& partition_config,
SessionStorageNamespace* session_storage_namespace);
// Random data ---------------------------------------------------------------
FrameTree& frame_tree() { return *frame_tree_; }
SSLManager* ssl_manager() { return &ssl_manager_; }
// Maximum number of entries before we start removing entries from the front.
static void set_max_entry_count_for_testing(size_t max_entry_count) {
max_entry_count_for_testing_ = max_entry_count;
}
static size_t max_entry_count();
void SetGetTimestampCallbackForTest(
const base::RepeatingCallback<base::Time()>& get_timestamp_callback);
// Discards only the pending entry. |was_failure| should be set if the pending
// entry is being discarded because it failed to load.
void DiscardPendingEntry(bool was_failure);
// Sets a flag on the pending NavigationEntryImpl instance if any that the
// navigation failed due to an SSL error.
void SetPendingNavigationSSLError(bool error);
// Returns true if the string corresponds to a valid data URL, false
// otherwise.
#if BUILDFLAG(IS_ANDROID)
static bool ValidateDataURLAsString(
const scoped_refptr<const base::RefCountedString>& data_url_as_string);
#endif
// Invoked when a user activation occurs within the page, so that relevant
// entries can be updated as needed.
void NotifyUserActivation();
// Tracks a new association between the current pending entry and a
// NavigationRequest. Callers are responsible for only calling this for
// requests corresponding to the current pending entry.
std::unique_ptr<PendingEntryRef> ReferencePendingEntry();
// Another page accessed the initial empty main document, which means it
// is no longer safe to display a pending URL without risking a URL spoof.
void DidAccessInitialMainDocument();
// The state for the page changed and should be updated in session history.
void UpdateStateForFrame(RenderFrameHostImpl* render_frame_host,
const blink::PageState& page_state);
// Like NavigationController::CreateNavigationEntry, but takes an extra
// argument, |source_process_site_url|.
// `rewrite_virtual_urls` is true when it needs to rewrite virtual urls
// (e.g., for outermost frames).
static std::unique_ptr<NavigationEntryImpl> CreateNavigationEntry(
const GURL& url,
Referrer referrer,
std::optional<url::Origin> initiator_origin,
std::optional<GURL> initiator_base_url,
std::optional<GURL> source_process_site_url,
ui::PageTransition transition,
bool is_renderer_initiated,
const std::string& extra_headers,
BrowserContext* browser_context,
scoped_refptr<network::SharedURLLoaderFactory> blob_url_loader_factory,
bool rewrite_virtual_urls);
// Called just before sending the commit to the renderer, or when restoring
// from back/forward cache. Walks the session history entries for the relevant
// FrameTreeNode, forward and backward from the pending entry. All contiguous
// and same-origin FrameNavigationEntries are serialized and returned.
// |request| may be nullptr when getting entries for an iframe that is being
// restored for back/forward cache (in that case, the iframe itself is not
// navigated, so there is no NavigationRequest).
blink::mojom::NavigationApiHistoryEntryArraysPtr
GetNavigationApiHistoryEntryVectors(FrameTreeNode* node,
NavigationRequest* request);
// The window.navigation API exposes the urls of some non-current same-origin
// FrameNavigationEntries to the renderer. This helper checks whether the
// given ReferrerPolicy makes an attempt to hide a page's URL (e.g., in
// referrer headers) and thus whether the URL should be hidden from navigation
// API history entries as well.
static bool ShouldProtectUrlInNavigationApi(
network::mojom::ReferrerPolicy referrer_policy);
// Returns whether the last NavigationEntry encountered a post-commit error.
bool has_post_commit_error_entry() const {
return entry_replaced_by_post_commit_error_ != nullptr;
}
// Whether the current call stack includes NavigateToPendingEntry, to avoid
// re-entrant calls to NavigateToPendingEntry.
// TODO(crbug.com/40841494): Don't expose this once we figure out the
// root cause for the navigation re-entrancy case in the linked bug.
bool in_navigate_to_pending_entry() const {
return in_navigate_to_pending_entry_;
}
// This flag is set from RenderFrameHostImpl::SendBeforeUnload() to
// investigate whether kAvoidUnnecessaryBeforeUnloadCheckSync feature is safe
// to enable or not (see: https://crbug.com/40361673,
// https://crbug.com/396998476).
void set_can_be_in_navigate_to_pending_entry(
const bool can_be_in_navigate_to_pending_entry) {
can_be_in_navigate_to_pending_entry_ = can_be_in_navigate_to_pending_entry;
}
// Whether to maintain a session history with just one entry.
//
// This returns true for a prerendering page and for fenced frames.
// `frame_tree_node` is checked to see if it belongs to a frame tree for
// prerendering or for a fenced frame.
// Explainer:
// https://github.com/jeremyroman/alternate-loading-modes/blob/main/browsing-context.md#session-history)
bool ShouldMaintainTrivialSessionHistory(
const FrameTreeNode* frame_tree_node) const;
// Called when the referrer policy changes. It updates whether to protect the
// url in the navigation API.
void DidChangeReferrerPolicy(FrameTreeNode* node,
network::mojom::ReferrerPolicy referrer_policy);
base::WeakPtr<NavigationControllerImpl> GetWeakPtr() {
return weak_factory_.GetWeakPtr();
}
private:
friend class RestoreHelper;
FRIEND_TEST_ALL_PREFIXES(TimeSmoother, Basic);
FRIEND_TEST_ALL_PREFIXES(TimeSmoother, SingleDuplicate);
FRIEND_TEST_ALL_PREFIXES(TimeSmoother, ManyDuplicates);
FRIEND_TEST_ALL_PREFIXES(TimeSmoother, ClockBackwardsJump);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerBrowserTest, PostThenReload);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerBrowserTest,
PostThenReplaceStateThenReload);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerBrowserTest,
PostThenPushStateThenReloadThenHistory);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerBrowserTest,
PostThenFragmentNavigationThenReloadThenHistory);
FRIEND_TEST_ALL_PREFIXES(
NavigationControllerBrowserTest,
PostThenBrowserInitiatedFragmentNavigationThenReload);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerBrowserTest, PostSubframe);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerBrowserTest,
ResetPendingLoadTypeWhenCancelPendingReload);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerDisableHistoryIntervention,
GoToOffsetWithSkippingDisableHistoryIntervention);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerHistoryInterventionBrowserTest,
GoToOffsetWithSkippingEnableHistoryIntervention);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerHistoryInterventionBrowserTest,
SetSkipOnBackForwardDoSkipForGoToOffsetWithSkipping);
FRIEND_TEST_ALL_PREFIXES(NavigationControllerHistoryInterventionBrowserTest,
SetSkipOnBackForwardDoNotSkipForGoToOffset);
// Defines possible actions that are returned by
// DetermineActionForHistoryNavigation().
enum class HistoryNavigationAction {
kStopLooking,
kKeepLooking,
kSameDocument,
kDifferentDocument,
};
enum class Direction { kForward, kBack };
// Helper class to smooth out runs of duplicate timestamps while still
// allowing time to jump backwards.
class CONTENT_EXPORT TimeSmoother {
public:
// Returns |t| with possibly some time added on.
base::Time GetSmoothedTime(base::Time t);
private:
// |low_water_mark_| is the first time in a sequence of adjusted
// times and |high_water_mark_| is the last.
base::Time low_water_mark_;
base::Time high_water_mark_;
};
// The repost dialog is suppressed during testing. However, it should be shown
// in some tests. This allows a test to elect to allow the repost dialog to
// show for a scoped duration.
class CONTENT_EXPORT ScopedShowRepostDialogForTesting {
public:
ScopedShowRepostDialogForTesting();
~ScopedShowRepostDialogForTesting();
ScopedShowRepostDialogForTesting(const ScopedShowRepostDialogForTesting&) =
delete;
ScopedShowRepostDialogForTesting& operator=(
const ScopedShowRepostDialogForTesting&) = delete;
private:
const bool was_disallowed_;
};
// Navigations to pending entries do not support re-entrancy due to a risk of
// use-after-free, and the pending entry itself should not be deleted during
// such a navigation. Create one of these scoped objects around calls to
// `Navigator::Navigate` when a pending entry is used, to safely crash rather
// than risk memory errors if re-entrancy or an unexpected deletion occurs.
// See https://crbug.com/40353566 for details.
class ScopedPendingEntryReentrancyGuard {
public:
explicit ScopedPendingEntryReentrancyGuard(
base::SafeRef<NavigationControllerImpl> controller);
~ScopedPendingEntryReentrancyGuard();
private:
base::SafeRef<NavigationControllerImpl> controller_;
std::unique_ptr<NavigationControllerImpl::PendingEntryRef>
pending_entry_ref_;
};
// Records which navigation API keys are associated with live frames.
// On destruction, does a final pass to filter out any keys that are still
// present in |entries_|, then sends the removed navigation API keys to the
// renderer so that the navigation API can fire dispose events for the
// entries associated with those keys.
class RemovedEntriesTracker {
public:
explicit RemovedEntriesTracker(
base::SafeRef<NavigationControllerImpl> controller);
~RemovedEntriesTracker();
private:
// Walk both directions from the last committed entry to find the navigation
// API keys of any FNEs that could be known by currently live documents.
// These FNEs are contiguous, so the walk can stop for a given frame when it
// reaches an FNE whose API key is no longer known to the current document.
void PopulateKeySet(Direction direction);
base::SafeRef<NavigationControllerImpl> controller_;
// Preprocessed maps used in PopulateKeySet(), mapping frame names
// to their respective FrameTreeNodes, and FrameTreeNode ids to their
// current document sequences numbers.
std::map<std::string, raw_ptr<FrameTreeNode, CtnExperimental>>
names_to_nodes_;
std::map<FrameTreeNodeId, int64_t> frame_tree_node_id_to_doc_seq_nos_;
// The output of PopulateKeySet(), which maps FrameTreeNode ids to the keys
// that frame knows about in the renderer. Used in the destructor.
std::map<FrameTreeNodeId, std::set<std::string>>
frame_tree_node_id_to_keys_;
};
// Navigates in session history to the given index. Returns all the created
// `NavigationRequest`s. If no request was created, the returned vector is
// empty.
// |initiator_rfh| is nullptr for browser-initiated navigations.
// |soft_navigation_heuristics_task_id|: The task in the renderer that
// initiated this call (if any).
// If this navigation originated from the navigation API, |navigation_api_key|
// will be set and indicate the navigation api key that |initiator_rfh|
// asked to be navigated to.
// |actual_navigation_start| is the time the navigation began, for metrics.
std::vector<base::WeakPtr<NavigationRequest>> GoToIndex(
int index,
RenderFrameHostImpl* initiator_rfh,
std::optional<blink::scheduler::TaskAttributionId>
soft_navigation_heuristics_task_id,
const std::string* navigation_api_key,
base::TimeTicks actual_navigation_start);
// Starts a navigation to an already existing pending NavigationEntry. Returns
// all the created `NavigationRequest`s. If no request was created, the
// returned vector is empty.
// |initiator_rfh| is nullptr for browser-initiated navigations.
// If this navigation originated from the navigation API, |navigation_api_key|
// will be set and indicate the navigation api key that |initiator_rfh|
// asked to be navigated to.
// |soft_navigation_heuristics_task_id|: The task in the renderer that
// initiated this call (if any).
// |actual_navigation_start| is the time the navigation began, for metrics.
std::vector<base::WeakPtr<NavigationRequest>> NavigateToExistingPendingEntry(
ReloadType reload_type,
RenderFrameHostImpl* initiator_rfh,
std::optional<blink::scheduler::TaskAttributionId>
soft_navigation_heuristics_task_id,
const std::string* navigation_api_key,
base::TimeTicks actual_navigation_start);
// Helper function used by FindFramesToNavigate to determine the appropriate
// action to take for a particular frame while navigating to
// |pending_entry_|.
HistoryNavigationAction DetermineActionForHistoryNavigation(
FrameTreeNode* frame,
ReloadType reload_type);
// Recursively identifies which frames need to be navigated for a navigation
// to |pending_entry_|, starting at |frame| and exploring its children.
// |same_document_loads| and |different_document_loads| will be filled with
// the NavigationRequests needed to navigate to |pending_entry_|.
// |actual_navigation_start| is the time the navigation began, for metrics.
// |soft_navigation_heuristics_task_id|: The task in the renderer that
// initiated this call (if any).
void FindFramesToNavigate(
FrameTreeNode* frame,
ReloadType reload_type,
const std::optional<blink::LocalFrameToken>& initiator_frame_token,
int initiator_process_id,
std::optional<blink::scheduler::TaskAttributionId>
soft_navigation_heuristics_task_id,
base::TimeTicks actual_navigation_start,
std::vector<std::unique_ptr<NavigationRequest>>* same_document_loads,
std::vector<std::unique_ptr<NavigationRequest>>*
different_document_loads);
// Starts a new navigation based on |load_params|, that doesn't correspond to
// an existing NavigationEntry.
// |actual_navigation_start| is the time the navigation began, for metrics.
base::WeakPtr<NavigationHandle> NavigateWithoutEntry(
const LoadURLParams& load_params,
base::TimeTicks actual_navigation_start);
// Handles a navigation to a renderer-debug URL.
void HandleRendererDebugURL(FrameTreeNode* frame_tree_node, const GURL& url);
// Creates and returns a NavigationEntry based on |load_params| for a
// navigation in |node|.
// |override_user_agent|, |should_replace_current_entry| and
// |has_user_gesture| will override the values from |load_params|. The same
// values should be passed to CreateNavigationRequestFromLoadParams.
std::unique_ptr<NavigationEntryImpl> CreateNavigationEntryFromLoadParams(
FrameTreeNode* node,
const LoadURLParams& load_params,
bool override_user_agent,
bool should_replace_current_entry,
bool has_user_gesture);
// Creates and returns a NavigationRequest based on |load_params| for a
// new navigation in |node|.
// Will return nullptr if the parameters are invalid and the navigation cannot
// start.
// |override_user_agent|, |should_replace_current_entry| and
// |has_user_gesture| will override the values from |load_params|. The same
// values should be passed to CreateNavigationEntryFromLoadParams.
// TODO(clamy): Remove the dependency on NavigationEntry and
// FrameNavigationEntry.
std::unique_ptr<NavigationRequest> CreateNavigationRequestFromLoadParams(
FrameTreeNode* node,
const LoadURLParams& load_params,
bool override_user_agent,
bool should_replace_current_entry,
bool has_user_gesture,
network::mojom::SourceLocationPtr source_location,
ReloadType reload_type,
NavigationEntryImpl* entry,
FrameNavigationEntry* frame_entry,
base::TimeTicks actual_navigation_start_time,
base::TimeTicks navigation_start_time,
bool is_embedder_initiated_fenced_frame_navigation = false,
bool is_unfenced_top_navigation = false,
bool is_container_initiated = false,
net::StorageAccessApiStatus storage_access_api_status =
net::StorageAccessApiStatus::kNone,
std::optional<std::u16string> embedder_shared_storage_context =
std::nullopt);
// Creates and returns a NavigationRequest for a navigation to |entry|. Will
// return nullptr if the parameters are invalid and the navigation cannot
// start.
// |soft_navigation_heuristics_task_id|: The task in the renderer that
// initiated this call (if any).
// TODO(clamy): Ensure this is only called for navigations to existing
// NavigationEntries.
std::unique_ptr<NavigationRequest> CreateNavigationRequestFromEntry(
FrameTreeNode* frame_tree_node,
NavigationEntryImpl* entry,
FrameNavigationEntry* frame_entry,
ReloadType reload_type,
bool is_same_document_history_load,
bool is_history_navigation_in_new_child_frame,
const std::optional<blink::LocalFrameToken>& initiator_frame_token,
int initiator_process_id,
base::TimeTicks actual_navigation_start,
std::optional<blink::scheduler::TaskAttributionId>
soft_navigation_heuristics_task_id = std::nullopt);
// Returns whether there is a pending NavigationEntry whose unique ID matches
// the given NavigationRequest's pending_nav_entry_id.
bool PendingEntryMatchesRequest(NavigationRequest* request) const;
// Classifies the given renderer navigation (see the NavigationType enum).
NavigationType ClassifyNavigation(
RenderFrameHostImpl* rfh,
const mojom::DidCommitProvisionalLoadParams& params,
NavigationRequest* navigation_request);
// Handlers for the different types of navigation types. They will actually
// handle the navigations corresponding to the different NavClasses above.
// They will NOT broadcast the commit notification, that should be handled by
// the caller.
//
// RendererDidNavigateAutoSubframe is special, it may not actually change
// anything if some random subframe is loaded. It will return true if anything
// changed, or false if not.
//
// The NewEntry and NewSubframe functions take in |replace_entry| to pass to
// InsertOrReplaceEntry, in case the newly created NavigationEntry is meant to
// replace the current one (e.g., for location.replace or successful loads
// after net errors), in contrast to updating a NavigationEntry in place
// (e.g., for history.replaceState).
void RendererDidNavigateToNewEntry(
RenderFrameHostImpl* rfh,
const mojom::DidCommitProvisionalLoadParams& params,
bool is_same_document,
bool replace_entry,
bool previous_document_had_history_intervention_activation,
NavigationRequest* request,
LoadCommittedDetails* details);
void RendererDidNavigateToExistingEntry(
RenderFrameHostImpl* rfh,
const mojom::DidCommitProvisionalLoadParams& params,
bool is_same_document,
bool was_restored,
NavigationRequest* request,
bool keep_pending_entry,
LoadCommittedDetails* details);
void RendererDidNavigateNewSubframe(
RenderFrameHostImpl* rfh,
const mojom::DidCommitProvisionalLoadParams& params,
bool is_same_document,
bool replace_entry,
bool previous_document_had_history_intervention_activation,
NavigationRequest* request,
LoadCommittedDetails* details);
bool RendererDidNavigateAutoSubframe(
RenderFrameHostImpl* rfh,
const mojom::DidCommitProvisionalLoadParams& params,
bool is_same_document,
bool was_on_initial_empty_document,
NavigationRequest* request,
LoadCommittedDetails* details);
// Allows the derived class to issue notifications that a load has been
// committed. This will fill in the active entry to the details structure.
void NotifyNavigationEntryCommitted(LoadCommittedDetails* details);
// Updates the virtual URL of an entry to match a new URL, for cases where
// the real renderer URL is derived from the virtual URL, like view-source:
void UpdateVirtualURLToURL(NavigationEntryImpl* entry, const GURL& new_url);
// Invoked after session/tab restore or cloning a tab. Resets the transition
// type of the entries, updates the max page id and creates the active
// contents.
void FinishRestore(int selected_index, RestoreType type);
// Inserts a new entry or replaces the current entry with a new one, removing
// all entries after it. The new entry will become the active one.
// If |was_post_commit_error_| is set, the last committed entry will be saved,
// the new entry will replace it, and on any navigation away from the new
// entry or on reloads, the old one will replace |entry|.
void InsertOrReplaceEntry(std::unique_ptr<NavigationEntryImpl> entry,
bool replace,
bool was_post_commit_error,
bool is_in_fenced_frame_tree,
LoadCommittedDetails* details);
// Removes the entry at |index|, as long as it is not the current entry.
void RemoveEntryAtIndexInternal(int index);
// If we have the maximum number of entries, remove the oldest entry that is
// marked to be skipped on back/forward button, in preparation to add another.
// If no entry is skippable, then the oldest entry will be pruned.
void PruneOldestSkippableEntryIfFull();
// Removes all entries except the last committed entry. If there is a new
// pending navigation it is preserved. In contrast to
// PruneAllButLastCommitted() this does not update the session history of the
// `blink::WebView`. Callers must ensure that `CanPruneAllButLastCommitted`
// returns true before calling this.
void PruneAllButLastCommittedInternal();
// Inserts up to |max_index| entries from |source| into this. This does NOT
// adjust any of the members that reference entries_
// (last_committed_entry_index_ or pending_entry_index_)
void InsertEntriesFrom(NavigationControllerImpl* source, int max_index);
// Returns the navigation index that differs from the current entry by the
// specified |offset|. The index returned is not guaranteed to be valid.
// This does not account for skippable entries or the history manipulation
// intervention.
int GetIndexForOffset(int offset);
// History Manipulation intervention:
// The previous document that started this navigation needs to be skipped in
// subsequent back/forward UI navigations if it never received any user
// gesture. This is to intervene against pages that manipulate the history
// such that the user is not able to go back to the last site they interacted
// with (crbug.com/907167).
// Note that this function must be called before the new navigation entry is
// inserted in |entries_| to make sure UKM reports the URL of the document
// adding the entry.
void SetShouldSkipOnBackForwardUIIfNeeded(
bool replace_entry,
bool previous_document_had_history_intervention_activation,
bool is_renderer_initiated,
ukm::SourceId previous_page_load_ukm_source_id);
// This function sets all same document entries with the same value
// of skippable flag. This is to avoid back button abuse by inserting
// multiple history entries and also to help valid cases where a user gesture
// on the document should apply to all same document history entries and none
// should be skipped. All entries belonging to the same document as the entry
// at |reference_index| will get their skippable flag set to |skippable|.
void SetSkippableForSameDocumentEntries(int reference_index, bool skippable);
// Called when one PendingEntryRef is deleted. When all of the refs for the
// current pending entry have been deleted, this automatically discards the
// pending NavigationEntry.
void PendingEntryRefDeleted(PendingEntryRef* ref);
// Computes the policy container policies to be stored in the
// FrameNavigationEntry by RendererDidNavigate.
std::unique_ptr<PolicyContainerPolicies>
ComputePolicyContainerPoliciesForFrameEntry(RenderFrameHostImpl* rfh,
bool is_same_document,
bool navigation_encountered_error,
const GURL& url);
// Adds details from a committed navigation to `entry` and the
// FrameNavigationEntry corresponding to `rfh`.
void UpdateNavigationEntryDetails(
NavigationEntryImpl* entry,
RenderFrameHostImpl* rfh,
const mojom::DidCommitProvisionalLoadParams& params,
NavigationRequest* request,
NavigationEntryImpl::UpdatePolicy update_policy,
bool is_new_entry,
LoadCommittedDetails* commit_details);
// Broadcasts this controller's session history index and length to all
// renderers involved in rendering the current page. The index is
// GetLastCommittedEntryIndex() and length is GetEntryCount().
void BroadcastHistoryIndexAndLength();
// Used by PopulateNavigationApiHistoryEntryVectors to initialize a single
// vector. `last_index_checked` is an out parameter that indicates the last
// entry index walked in `direction` before stopping.
std::vector<blink::mojom::NavigationApiHistoryEntryPtr>
PopulateSingleNavigationApiHistoryEntryVector(
Direction direction,
int entry_index,
const url::Origin& pending_origin,
FrameTreeNode* node,
SiteInstance* site_instance,
int64_t pending_item_sequence_number,
int64_t pending_document_sequence_number,
int& last_index_checked);
// Helper for NavigateToNavigationApiKey(). Ensures that we only navigate to
// |target_entry| if it matches |current_entry|'s origin and site instance, as
// well as having |navigation_api_key| as its key.
HistoryNavigationAction ShouldNavigateToEntryForNavigationApiKey(
FrameNavigationEntry* current_entry,
FrameNavigationEntry* target_entry,
const std::string& navigation_api_key);
// When navigation starts, the `can_be_in_navigate_to_pending_entry` flag has
// to be false. This is because kAvoidUnnecessaryBeforeUnloadCheckSync feature
// will stop using PostTask for the legacy beforeunload code in the near
// future. When kAvoidUnnecessaryBeforeUnloadCheckSync is enabled,
// `RenderFrameHostImpl::ProcessBeforeUnloadCompletedFromFrame()` and
// `Navigator::BeforeUnloadCompleted()` can run in the scope of
// `in_navigate_to_pending_entry_` == true, and it might end up crashing on
// CHECK(!in_navigate_to_pending_entry_).
void CheckPotentialNavigationReentrancy();
// Creates a NavigationRequest to use for browser-initiated error page
// navigations. When the request is started, it will navigate the
// FrameTreeNode corresponding to |render_frame_host_impl| to an error page,
// with |url| as the URL and |error_page_html| as the content. If
// |is_post_commit_error_page| is true, the entire NavigationEntry will be
// temporarily replaced when the navigation completes, otherwise it will be
// fully replaced. See |NavigationController::LoadPostCommitErrorPage()| and
// |NavigationControllerImpl::NavigateFrameToErrorPage()| for more details on
// this distinction.
std::unique_ptr<NavigationRequest> CreateNavigationRequestForErrorPage(
RenderFrameHostImpl* render_frame_host_impl,
const GURL& url,
const std::string& error_page_html,
bool is_post_commit_error_page);
// Finds the target FrameTreeNode for navigation. Returns the node specified
// by |params| via ID or name, or the root node if none specified.
FrameTreeNode* GetTargetFrameTreeNodeForNavigation(
const LoadURLParams& params);
// ---------------------------------------------------------------------------
// The FrameTree this instance belongs to. Each FrameTree gets its own
// NavigationController.
const raw_ref<FrameTree> frame_tree_;
// The user browser context associated with this controller.
const raw_ptr<BrowserContext> browser_context_;
// List of |NavigationEntry|s for this controller.
std::vector<std::unique_ptr<NavigationEntryImpl>> entries_;
// An entry we haven't gotten a response for yet. This will be discarded
// when we navigate again. It's used only so we know what the currently
// displayed tab is.
//
// This may refer to an item in the entries_ list if the pending_entry_index_
// != -1, or it may be its own entry that should be deleted. Be careful with
// the memory management.
raw_ptr<NavigationEntryImpl> pending_entry_ = nullptr;
// This keeps track of the NavigationRequests associated with the pending
// NavigationEntry. When all of them have been deleted, or have stopped
// loading, the pending NavigationEntry can be discarded.
//
// This is meant to avoid a class of URL spoofs where the navigation is
// canceled, but the stale pending NavigationEntry is left in place.
std::set<raw_ptr<PendingEntryRef, SetExperimental>> pending_entry_refs_;
// If a new entry fails loading, details about it are temporarily held here
// until the error page is shown (or 0 otherwise).
//
// TODO(avi): We need a better way to handle the connection between failed
// loads and the subsequent load of the error page. This current approach has
// issues: 1. This might hang around longer than we'd like if there is no
// error page loaded, and 2. This doesn't work very well for frames.
// http://crbug.com/474261
int failed_pending_entry_id_ = 0;
// The index of the currently visible entry.
int last_committed_entry_index_ = -1;
// The index of the pending entry if it is in entries_, or -1 if
// pending_entry_ is a new entry (created by LoadURL).
int pending_entry_index_ = -1;
// The delegate associated with the controller. Possibly null during
// setup.
raw_ptr<NavigationControllerDelegate> delegate_;
// Manages the SSL security UI.
SSLManager ssl_manager_;
// Whether we need to be reloaded when made active.
bool needs_reload_ = false;
// Source of when |needs_reload_| is set. Only valid when |needs_reload_|
// is set.
NeedsReloadType needs_reload_type_ = NeedsReloadType::kRequestedByClient;
// Whether this is the initial navigation.
// Becomes false when initial navigation commits.
bool is_initial_navigation_ = true;
// Prevent unsafe re-entrant calls to NavigateToPendingEntry.
bool in_navigate_to_pending_entry_ = false;
// A flag to investigate whether kAvoidUnnecessaryBeforeUnloadCheckSync
// feature is safe to enable or not (see: https://crbug.com/40361673,
// https://crbug.com/396998476).
//
// This flag is true if the above `in_navigate_to_pending_entry_` flag is true
// when RenderFrameHostImpl::SendBeforeUnload() runs, and on top of that, when
// we intend to continue navigation synchronously without posting a task when
// the kAvoidUnnecessaryBeforeUnloadCheckSync feature is enabled in either
// kWithSendBeforeUnload or kWithoutSendBeforeUnload mode.
bool can_be_in_navigate_to_pending_entry_ = false;
// Used to find the appropriate SessionStorageNamespace for the storage
// partition of a NavigationEntry.
//
// A NavigationController may contain NavigationEntries that correspond to
// different StoragePartitions. Even though they are part of the same
// NavigationController, only entries in the same StoragePartition may
// share session storage state with one another.
SessionStorageNamespaceMap session_storage_namespace_map_;
// The maximum number of entries that a navigation controller can store.
static size_t max_entry_count_for_testing_;
// If a repost is pending, its type (RELOAD or RELOAD_BYPASSING_CACHE),
// NO_RELOAD otherwise.
ReloadType pending_reload_ = ReloadType::NONE;
// Used to get timestamps for newly-created navigation entries.
base::RepeatingCallback<base::Time()> get_timestamp_callback_;
// Used to smooth out timestamps from |get_timestamp_callback_|.
// Without this, whenever there is a run of redirects or
// code-generated navigations, those navigations may occur within
// the timer resolution, leading to things sometimes showing up in
// the wrong order in the history view.
TimeSmoother time_smoother_;
// BackForwardCache:
//
// Stores frozen RenderFrameHost. Restores them on history navigation.
// See BackForwardCache class documentation.
BackForwardCacheImpl back_forward_cache_;
// Stores captured screenshots for this `NavigationController`. The
// screenshots are used to present the user with the previews of the
// previously visited pages when the back/forward navigations occur.
std::unique_ptr<NavigationEntryScreenshotCache> nav_entry_screenshot_cache_;
// Holds the entry that was committed at the time an error page was triggered
// due to a call to LoadPostCommitErrorPage. The error entry will take its
// place until the user navigates again, at which point it will go back into
// the entry list instead of the error entry. Set to nullptr if there is no
// post commit error entry. Note that this entry must always correspond to the
// last committed entry index, and that there can be only a single post-commit
// error page entry in its place in entries_. This ensures that its spot in
// entries_ cannot go away (e.g., due to PruneForwardEntries) and that it can
// go back into place after any subsequent commit.
std::unique_ptr<NavigationEntryImpl> entry_replaced_by_post_commit_error_;
// NOTE: This must be the last member.
base::WeakPtrFactory<NavigationControllerImpl> weak_factory_{this};
};
} // namespace content
#endif // CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_CONTROLLER_IMPL_H_
|