blob: 4be72d52cb1c93d1322628d9e3c6088e176725dd [file] [log] [blame]
Avi Drissman4e1b7bc32022-09-15 14:03:501// Copyright 2013 The Chromium Authors
license.botbf09a502008-08-24 00:55:552// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit09911bf2008-07-26 23:55:294
creis4e2ecb72015-06-20 00:46:305/*
6 * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
7 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
8 * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
9 * (http://www.torchmobile.com/)
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 *
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
21 * its contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
25 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
28 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
danakjc492bf82020-09-09 20:02:4436#include "content/browser/renderer_host/navigation_controller_impl.h"
initial.commit09911bf2008-07-26 23:55:2937
Lei Zhang96031532019-10-10 19:05:4738#include <algorithm>
dcheng36b6aec92015-12-26 06:16:3639#include <utility>
40
[email protected]eabfe1912014-05-12 10:07:2841#include "base/command_line.h"
Ayu Ishii2f825852022-03-08 19:47:3842#include "base/containers/adapters.h"
Rakina Zata Amni627360d2022-02-24 00:53:4043#include "base/debug/dump_without_crashing.h"
Avi Drissmanadac21992023-01-11 23:46:3944#include "base/functional/bind.h"
initial.commit09911bf2008-07-26 23:55:2945#include "base/logging.h"
asvitkine30330812016-08-30 04:01:0846#include "base/metrics/histogram_macros.h"
Charlie Reis23c26da2022-01-29 00:57:4747#include "base/numerics/safe_conversions.h"
Ryan Hamilton7f3bd3d2022-04-23 00:07:3948#include "base/strings/escape.h"
[email protected]348fbaac2013-06-11 06:31:5149#include "base/strings/string_util.h"
[email protected]74ebfb12013-06-07 20:48:0050#include "base/strings/utf_string_conversions.h"
[email protected]a43858f2013-06-28 15:18:3751#include "base/time/time.h"
Carlos Caballero40b0efd2021-01-26 11:55:0052#include "base/trace_event/optional_trace_event.h"
ssid3e765612015-01-28 04:03:4253#include "base/trace_event/trace_event.h"
Daniel Chengabb006862022-09-09 22:39:0854#include "base/types/optional_util.h"
servolkf3955532015-05-16 00:01:5955#include "build/build_config.h"
[email protected]eabfe1912014-05-12 10:07:2856#include "cc/base/switches.h"
jamescookda2505812015-03-20 18:01:1857#include "content/browser/bad_message.h"
Marijn Kruisselbrink0c87e6e2018-06-22 22:57:3958#include "content/browser/blob_storage/chrome_blob_storage_context.h"
William Liu055a3542023-04-02 17:21:1959#include "content/browser/browser_context_impl.h"
[email protected]825b1662012-03-12 19:07:3160#include "content/browser/browser_url_handler_impl.h"
[email protected]5f2aa722013-08-07 16:59:4161#include "content/browser/dom_storage/dom_storage_context_wrapper.h"
[email protected]1ea3c792012-04-17 01:25:0462#include "content/browser/dom_storage/session_storage_namespace_impl.h"
Nate Chapinc06cf80a2023-11-18 01:12:2563#include "content/browser/preloading/prerender/prerender_host.h"
Sharon Yang242ef822023-05-15 21:07:3264#include "content/browser/process_lock.h"
Mingyu Lei68f34412023-08-21 07:31:3765#include "content/browser/renderer_host/back_forward_cache_impl.h"
danakjc492bf82020-09-09 20:02:4466#include "content/browser/renderer_host/debug_urls.h"
67#include "content/browser/renderer_host/frame_tree.h"
Carlos Caballero40b0efd2021-01-26 11:55:0068#include "content/browser/renderer_host/frame_tree_node.h"
Chris Bookholt27faf8d2022-01-20 01:03:3369#include "content/browser/renderer_host/navigation_controller_delegate.h"
danakjc492bf82020-09-09 20:02:4470#include "content/browser/renderer_host/navigation_entry_impl.h"
Nate Chapin214a86a2021-06-21 20:35:5771#include "content/browser/renderer_host/navigation_entry_restore_context_impl.h"
danakjc492bf82020-09-09 20:02:4472#include "content/browser/renderer_host/navigation_request.h"
William Liu055a3542023-04-02 17:21:1973#include "content/browser/renderer_host/navigation_transitions/navigation_entry_screenshot_cache.h"
74#include "content/browser/renderer_host/navigation_transitions/navigation_entry_screenshot_manager.h"
Khushal Sagar94ea2dc2024-08-06 17:15:2675#include "content/browser/renderer_host/navigation_transitions/navigation_transition_config.h"
danakjc492bf82020-09-09 20:02:4476#include "content/browser/renderer_host/navigator.h"
Takashi Toyoshima4dad2c12023-11-13 10:04:4677#include "content/browser/renderer_host/page_delegate.h"
danakjc492bf82020-09-09 20:02:4478#include "content/browser/renderer_host/render_frame_host_delegate.h"
Carlos Caballero40b0efd2021-01-26 11:55:0079#include "content/browser/renderer_host/render_view_host_impl.h"
Mike Jacksone2aa7af2023-05-17 06:45:0780#include "content/browser/renderer_host/system_entropy_utils.h"
Sharon Yangd70a5392021-10-26 23:06:3281#include "content/browser/site_info.h"
[email protected]b6583592012-01-25 19:52:3382#include "content/browser/site_instance_impl.h"
Camille Lamy5193caa2018-10-12 11:59:4283#include "content/common/content_constants_internal.h"
Rakina Zata Amni84a859df2024-06-07 15:56:3284#include "content/common/content_navigation_policy.h"
Nate Chapind1fe3612021-04-16 20:45:5785#include "content/common/navigation_params_utils.h"
Nasko Oskovae49e292020-08-13 02:08:5186#include "content/common/trace_utils.h"
[email protected]ccb797302011-12-15 16:55:1187#include "content/public/browser/browser_context.h"
[email protected]d1198fd2012-08-13 22:50:1988#include "content/public/browser/content_browser_client.h"
Fergal Daly1336ac642021-09-14 15:13:1189#include "content/public/browser/disallow_activation_reason.h"
[email protected]d9083482012-01-06 00:38:4690#include "content/public/browser/invalidate_type.h"
[email protected]5b96836f2011-12-22 07:39:0091#include "content/public/browser/navigation_details.h"
Lei Zhang96031532019-10-10 19:05:4792#include "content/public/browser/render_view_host.h"
[email protected]9677a3c2012-12-22 04:18:5893#include "content/public/browser/render_widget_host.h"
94#include "content/public/browser/render_widget_host_view.h"
Mikel Astizba9cf2fd2017-12-17 10:38:1095#include "content/public/browser/replaced_navigation_entry_data.h"
[email protected]4c3a23582012-08-18 08:54:3496#include "content/public/browser/storage_partition.h"
[email protected]d1198fd2012-08-13 22:50:1997#include "content/public/common/content_client.h"
[email protected]7f6f44c2011-12-14 13:23:3898#include "content/public/common/content_constants.h"
toyoshim86e34ec2016-02-25 08:56:1099#include "content/public/common/content_features.h"
Lei Zhang96031532019-10-10 19:05:47100#include "content/public/common/url_constants.h"
clamy7fced7b2017-11-16 19:52:43101#include "content/public/common/url_utils.h"
servolkf3955532015-05-16 00:01:59102#include "media/base/mime_util.h"
Lei Zhanga4770832023-07-19 18:02:36103#include "net/base/net_errors.h"
Arthur Sonzogni620cec62018-12-13 13:08:57104#include "net/http/http_status_code.h"
Shivani Sharma93329102019-01-24 19:44:18105#include "services/metrics/public/cpp/ukm_builders.h"
106#include "services/metrics/public/cpp/ukm_recorder.h"
Yue Ru Sun128804932020-09-30 22:19:17107#include "services/metrics/public/cpp/ukm_source_id.h"
Nan Lind91c8152021-10-21 16:22:37108#include "services/network/public/mojom/fetch_api.mojom.h"
William Liu2c825472022-10-31 12:01:44109#include "services/network/public/mojom/url_response_head.mojom-shared.h"
[email protected]9677a3c2012-12-22 04:18:58110#include "skia/ext/platform_canvas.h"
Marijn Kruisselbrink0c87e6e2018-06-22 22:57:39111#include "third_party/blink/public/common/blob/blob_utils.h"
Gyuyoung Kim107c2a02021-04-13 01:49:30112#include "third_party/blink/public/common/chrome_debug_urls.h"
Miyoung Shin1c565c912021-03-17 12:11:21113#include "third_party/blink/public/common/history/session_history_constants.h"
Blink Reformata30d4232018-04-07 15:31:06114#include "third_party/blink/public/common/mime_util/mime_util.h"
Minggang Wanga13c796e2021-07-02 05:54:43115#include "third_party/blink/public/common/navigation/navigation_params.h"
Carlos Caballeroede6f8c2021-01-28 11:01:50116#include "third_party/blink/public/common/page_state/page_state_serialization.h"
Minggang Wangb9f3fa92021-07-01 15:30:31117#include "third_party/blink/public/mojom/navigation/navigation_params.mojom.h"
Minggang Wang7ee0c742021-06-16 16:16:51118#include "third_party/blink/public/mojom/navigation/prefetched_signed_exchange_info.mojom.h"
Jiewei Qian87951f52023-10-17 01:33:46119#include "third_party/blink/public/mojom/runtime_feature_state/runtime_feature.mojom.h"
[email protected]cca6f392014-05-28 21:32:26120#include "url/url_constants.h"
initial.commit09911bf2008-07-26 23:55:29121
[email protected]8ff00d72012-10-23 19:12:21122namespace content {
[email protected]e9ba4472008-09-14 15:42:43123namespace {
124
125// Invoked when entries have been pruned, or removed. For example, if the
126// current entries are [google, digg, yahoo], with the current entry google,
127// and the user types in cnet, then digg and yahoo are pruned.
[email protected]d202a7c2012-01-04 07:53:47128void NotifyPrunedEntries(NavigationControllerImpl* nav_controller,
Shivani Sharmab9c46de82019-02-08 16:54:50129 int index,
[email protected]c12bf1a12008-09-17 16:28:49130 int count) {
[email protected]8ff00d72012-10-23 19:12:21131 PrunedDetails details;
Shivani Sharmab9c46de82019-02-08 16:54:50132 details.index = index;
[email protected]c12bf1a12008-09-17 16:28:49133 details.count = count;
Sam McNally5c087a32017-08-25 01:46:14134 nav_controller->delegate()->NotifyNavigationListPruned(details);
[email protected]e9ba4472008-09-14 15:42:43135}
136
[email protected]e9ba4472008-09-14 15:42:43137// Configure all the NavigationEntries in entries for restore. This resets
138// the transition type to reload and makes sure the content state isn't empty.
139void ConfigureEntriesForRestore(
dcheng9bfa5162016-04-09 01:00:57140 std::vector<std::unique_ptr<NavigationEntryImpl>>* entries,
toyoshim0df1d3a2016-09-09 09:52:48141 RestoreType type) {
Lei Zhang96031532019-10-10 19:05:47142 for (auto& entry : *entries) {
[email protected]e9ba4472008-09-14 15:42:43143 // Use a transition type of reload so that we don't incorrectly increase
144 // the typed count.
Lei Zhang96031532019-10-10 19:05:47145 entry->SetTransitionType(ui::PAGE_TRANSITION_RELOAD);
146 entry->set_restore_type(type);
[email protected]e9ba4472008-09-14 15:42:43147 }
148}
149
[email protected]bf70edce2012-06-20 22:32:22150// Determines whether or not we should be carrying over a user agent override
151// between two NavigationEntries.
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57152bool ShouldKeepOverride(NavigationEntry* last_entry) {
[email protected]bf70edce2012-06-20 22:32:22153 return last_entry && last_entry->GetIsOverridingUserAgent();
154}
155
Camille Lamy5193caa2018-10-12 11:59:42156// Determines whether to override user agent for a navigation.
157bool ShouldOverrideUserAgent(
158 NavigationController::UserAgentOverrideOption override_user_agent,
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57159 NavigationEntry* last_committed_entry) {
Camille Lamy5193caa2018-10-12 11:59:42160 switch (override_user_agent) {
161 case NavigationController::UA_OVERRIDE_INHERIT:
162 return ShouldKeepOverride(last_committed_entry);
163 case NavigationController::UA_OVERRIDE_TRUE:
164 return true;
165 case NavigationController::UA_OVERRIDE_FALSE:
166 return false;
Camille Lamy5193caa2018-10-12 11:59:42167 }
Peter Boström8472105d2024-05-15 04:36:02168 NOTREACHED_IN_MIGRATION();
Camille Lamy5193caa2018-10-12 11:59:42169 return false;
170}
171
Rakina Zata Amni312822d72021-06-04 16:13:37172// Returns true if this navigation should be treated as a reload. For e.g.
clamy0a656e42018-02-06 18:18:28173// navigating to the last committed url via the address bar or clicking on a
Rakina Zata Amni312822d72021-06-04 16:13:37174// link which results in a navigation to the last committed URL (but wasn't
175// converted to do a replacement navigation in the renderer), etc.
Fergal Daly766177d2020-07-07 07:54:04176// |node| is the FrameTreeNode which is navigating. |url|, |virtual_url|,
177// |base_url_for_data_url|, |transition_type| correspond to the new navigation
178// (i.e. the pending NavigationEntry). |last_committed_entry| is the last
179// navigation that committed.
180bool ShouldTreatNavigationAsReload(FrameTreeNode* node,
181 const GURL& url,
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57182 const GURL& virtual_url,
183 const GURL& base_url_for_data_url,
184 ui::PageTransition transition_type,
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57185 bool is_post,
Rakina Zata Amni312822d72021-06-04 16:13:37186 bool should_replace_current_entry,
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57187 NavigationEntryImpl* last_committed_entry) {
Rakina Zata Amni312822d72021-06-04 16:13:37188 // Navigations intended to do a replacement shouldn't be converted to do a
189 // reload.
190 if (should_replace_current_entry)
clamy0a656e42018-02-06 18:18:28191 return false;
clamy0a656e42018-02-06 18:18:28192 // Only convert to reload if at least one navigation committed.
Rakina Zata Amnie2d31312022-11-18 03:38:45193 if (last_committed_entry->IsInitialEntry())
ananta3bdd8ae2016-12-22 17:11:55194 return false;
195
arthursonzogni7a8243682017-12-14 16:41:42196 // Skip navigations initiated by external applications.
clamy0a656e42018-02-06 18:18:28197 if (transition_type & ui::PAGE_TRANSITION_FROM_API)
arthursonzogni7a8243682017-12-14 16:41:42198 return false;
199
ananta3bdd8ae2016-12-22 17:11:55200 // We treat (PAGE_TRANSITION_RELOAD | PAGE_TRANSITION_FROM_ADDRESS_BAR),
201 // PAGE_TRANSITION_TYPED or PAGE_TRANSITION_LINK transitions as navigations
202 // which should be treated as reloads.
clamy0a656e42018-02-06 18:18:28203 bool transition_type_can_be_converted = false;
204 if (ui::PageTransitionCoreTypeIs(transition_type,
205 ui::PAGE_TRANSITION_RELOAD) &&
206 (transition_type & ui::PAGE_TRANSITION_FROM_ADDRESS_BAR)) {
207 transition_type_can_be_converted = true;
ananta3bdd8ae2016-12-22 17:11:55208 }
clamy0a656e42018-02-06 18:18:28209 if (ui::PageTransitionCoreTypeIs(transition_type,
ananta3bdd8ae2016-12-22 17:11:55210 ui::PAGE_TRANSITION_TYPED)) {
clamy0a656e42018-02-06 18:18:28211 transition_type_can_be_converted = true;
212 }
213 if (ui::PageTransitionCoreTypeIs(transition_type, ui::PAGE_TRANSITION_LINK))
214 transition_type_can_be_converted = true;
215 if (!transition_type_can_be_converted)
216 return false;
217
218 // This check is required for cases like view-source:, etc. Here the URL of
219 // the navigation entry would contain the url of the page, while the virtual
220 // URL contains the full URL including the view-source prefix.
221 if (virtual_url != last_committed_entry->GetVirtualURL())
222 return false;
223
Fergal Daly766177d2020-07-07 07:54:04224 // Check that the URLs match.
225 FrameNavigationEntry* frame_entry = last_committed_entry->GetFrameEntry(node);
226 // If there's no frame entry then by definition the URLs don't match.
227 if (!frame_entry)
228 return false;
229
230 if (url != frame_entry->url())
clamy0a656e42018-02-06 18:18:28231 return false;
232
233 // This check is required for Android WebView loadDataWithBaseURL. Apps
234 // can pass in anything in the base URL and we need to ensure that these
235 // match before classifying it as a reload.
236 if (url.SchemeIs(url::kDataScheme) && base_url_for_data_url.is_valid()) {
237 if (base_url_for_data_url != last_committed_entry->GetBaseURLForDataURL())
238 return false;
ananta3bdd8ae2016-12-22 17:11:55239 }
240
clamy0a656e42018-02-06 18:18:28241 // Skip entries with SSL errors.
242 if (last_committed_entry->ssl_error())
243 return false;
244
245 // Don't convert to a reload when the last navigation was a POST or the new
246 // navigation is a POST.
Fergal Daly766177d2020-07-07 07:54:04247 if (frame_entry->get_has_post_data() || is_post)
clamy0a656e42018-02-06 18:18:28248 return false;
249
250 return true;
ananta3bdd8ae2016-12-22 17:11:55251}
252
Arthur Sonzognic686e8f2024-01-11 08:36:37253std::optional<url::Origin> GetCommittedOriginForFrameEntry(
Rakina Zata Amni3a1c0ec2021-04-15 03:35:12254 const mojom::DidCommitProvisionalLoadParams& params,
255 NavigationRequest* request) {
Nasko Oskov03912102019-01-11 00:21:32256 // Error pages commit in an opaque origin, yet have the real URL that resulted
257 // in an error as the |params.url|. Since successful reload of an error page
258 // should commit in the correct origin, setting the opaque origin on the
259 // FrameNavigationEntry will be incorrect.
Rakina Zata Amniafd3c6582021-11-30 06:19:17260 if (request && request->DidEncounterError())
Arthur Sonzognic686e8f2024-01-11 08:36:37261 return std::nullopt;
Nasko Oskov03912102019-01-11 00:21:32262
Arthur Sonzognic686e8f2024-01-11 08:36:37263 return std::make_optional(params.origin);
Nasko Oskov03912102019-01-11 00:21:32264}
265
Alex Moshchuk99242832023-05-22 17:21:44266bool IsValidURLForNavigation(FrameTreeNode* node,
Camille Lamy5193caa2018-10-12 11:59:42267 const GURL& virtual_url,
268 const GURL& dest_url) {
269 // Don't attempt to navigate if the virtual URL is non-empty and invalid.
Alex Moshchuk99242832023-05-22 17:21:44270 if (node->IsOutermostMainFrame() && !virtual_url.is_valid() &&
271 !virtual_url.is_empty()) {
Camille Lamy5193caa2018-10-12 11:59:42272 LOG(WARNING) << "Refusing to load for invalid virtual URL: "
273 << virtual_url.possibly_invalid_spec();
274 return false;
275 }
276
277 // Don't attempt to navigate to non-empty invalid URLs.
278 if (!dest_url.is_valid() && !dest_url.is_empty()) {
279 LOG(WARNING) << "Refusing to load invalid URL: "
280 << dest_url.possibly_invalid_spec();
281 return false;
282 }
283
284 // The renderer will reject IPC messages with URLs longer than
285 // this limit, so don't attempt to navigate with a longer URL.
286 if (dest_url.spec().size() > url::kMaxURLChars) {
287 LOG(WARNING) << "Refusing to load URL as it exceeds " << url::kMaxURLChars
288 << " characters.";
289 return false;
290 }
291
Aaron Colwell33109c592020-04-21 21:31:19292 // Reject renderer debug URLs because they should have been handled before
293 // we get to this point. This check handles renderer debug URLs
294 // that are inside a view-source: URL (e.g. view-source:chrome://kill) and
295 // provides defense-in-depth if a renderer debug URL manages to get here via
296 // some other path. We want to reject the navigation here so it doesn't
297 // violate assumptions in downstream code.
Gyuyoung Kim107c2a02021-04-13 01:49:30298 if (blink::IsRendererDebugURL(dest_url)) {
Aaron Colwell33109c592020-04-21 21:31:19299 LOG(WARNING) << "Refusing to load renderer debug URL: "
300 << dest_url.possibly_invalid_spec();
301 return false;
302 }
303
Alex Moshchuk99242832023-05-22 17:21:44304 // Guests only support navigations to known-safe schemes. This check already
305 // exists in the extensions layer, where it also dispatches proper events to
306 // the guest's embedder (see WebViewGuest::LoadURLWithParams). This check is
307 // for defense-in-depth to ensure that no other places in the codebase
308 // accidentally navigate guests to schemes such as WebUI, which is not
309 // supported. See https://crbug.com/1444221.
310 if (node->current_frame_host()->GetSiteInstance()->IsGuest()) {
311 auto* cpsp = content::ChildProcessSecurityPolicy::GetInstance();
312 if (!cpsp->IsWebSafeScheme(dest_url.scheme()) &&
313 !dest_url.SchemeIs(url::kAboutScheme)) {
314 LOG(WARNING) << "Refusing to load unsafe URL in a guest: "
315 << dest_url.possibly_invalid_spec();
316 return false;
317 }
318 }
319
Camille Lamy5193caa2018-10-12 11:59:42320 return true;
321}
322
Mikel Astizba9cf2fd2017-12-17 10:38:10323// See replaced_navigation_entry_data.h for details: this information is meant
324// to ensure |*output_entry| keeps track of its original URL (landing page in
325// case of server redirects) as it gets replaced (e.g. history.replaceState()),
326// without overwriting it later, for main frames.
327void CopyReplacedNavigationEntryDataIfPreviouslyEmpty(
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57328 NavigationEntryImpl* replaced_entry,
Mikel Astizba9cf2fd2017-12-17 10:38:10329 NavigationEntryImpl* output_entry) {
Rakina Zata Amniafd3c6582021-11-30 06:19:17330 if (output_entry->GetReplacedEntryData().has_value() ||
331 replaced_entry->IsInitialEntry()) {
Mikel Astizba9cf2fd2017-12-17 10:38:10332 return;
Rakina Zata Amniafd3c6582021-11-30 06:19:17333 }
Mikel Astizba9cf2fd2017-12-17 10:38:10334
335 ReplacedNavigationEntryData data;
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57336 data.first_committed_url = replaced_entry->GetURL();
337 data.first_timestamp = replaced_entry->GetTimestamp();
338 data.first_transition_type = replaced_entry->GetTransitionType();
Charlie Reisb55438f2019-01-08 01:54:29339 output_entry->set_replaced_entry_data(data);
Mikel Astizba9cf2fd2017-12-17 10:38:10340}
341
Minggang Wangb9f3fa92021-07-01 15:30:31342blink::mojom::NavigationType GetNavigationType(
343 const GURL& old_url,
344 const GURL& new_url,
345 ReloadType reload_type,
346 NavigationEntryImpl* entry,
347 const FrameNavigationEntry& frame_entry,
348 bool has_pending_cross_document_commit,
349 bool is_currently_error_page,
Garrett Tanzer405f3402022-07-21 20:12:49350 bool is_same_document_history_load,
Garrett Tanzer267c2b82022-07-26 16:53:13351 bool is_embedder_initiated_fenced_frame_navigation,
Garrett Tanzer405f3402022-07-21 20:12:49352 bool is_unfenced_top_navigation) {
clamyea99ea12018-05-28 13:54:23353 // Reload navigations
354 switch (reload_type) {
355 case ReloadType::NORMAL:
Minggang Wangb9f3fa92021-07-01 15:30:31356 return blink::mojom::NavigationType::RELOAD;
clamyea99ea12018-05-28 13:54:23357 case ReloadType::BYPASSING_CACHE:
Minggang Wangb9f3fa92021-07-01 15:30:31358 return blink::mojom::NavigationType::RELOAD_BYPASSING_CACHE;
clamyea99ea12018-05-28 13:54:23359 case ReloadType::NONE:
360 break; // Fall through to rest of function.
361 }
362
Lukasz Anforowicz6b75c0d2020-12-01 22:56:08363 if (entry->IsRestored()) {
Minggang Wangb9f3fa92021-07-01 15:30:31364 return entry->GetHasPostData()
365 ? blink::mojom::NavigationType::RESTORE_WITH_POST
366 : blink::mojom::NavigationType::RESTORE;
clamyea99ea12018-05-28 13:54:23367 }
368
danakjb952ef12021-01-14 19:58:49369 const bool can_be_same_document =
370 // A pending cross-document commit means this navigation will not occur in
371 // the current document, as that document would end up being replaced in
372 // the meantime.
373 !has_pending_cross_document_commit &&
374 // If the current document is an error page, we should always treat it as
375 // a different-document navigation so that we'll attempt to load the
376 // document we're navigating to (and not stay in the current error page).
Garrett Tanzer405f3402022-07-21 20:12:49377 !is_currently_error_page &&
Garrett Tanzer267c2b82022-07-26 16:53:13378 // If the navigation is an embedder-initiated navigation of a fenced
379 // frame root (i.e. enters a fenced frame tree from outside),
380 // same-document navigations should be disabled because we don't want to
381 // allow information to be joined across multiple embedder-initiated
382 // fenced frame navigations (which may contain separate cross-site data).
383 !is_embedder_initiated_fenced_frame_navigation &&
Garrett Tanzer405f3402022-07-21 20:12:49384 // If the navigation is to _unfencedTop (i.e. escapes a fenced frame),
385 // same-document navigations should be disabled because we want to force
386 // the creation of a new browsing context group.
387 !is_unfenced_top_navigation;
danakjd83d706d2020-11-25 22:11:12388
clamyea99ea12018-05-28 13:54:23389 // History navigations.
390 if (frame_entry.page_state().IsValid()) {
danakjd83d706d2020-11-25 22:11:12391 return can_be_same_document && is_same_document_history_load
Minggang Wangb9f3fa92021-07-01 15:30:31392 ? blink::mojom::NavigationType::HISTORY_SAME_DOCUMENT
393 : blink::mojom::NavigationType::HISTORY_DIFFERENT_DOCUMENT;
clamyea99ea12018-05-28 13:54:23394 }
395 DCHECK(!is_same_document_history_load);
396
397 // A same-document fragment-navigation happens when the only part of the url
398 // that is modified is after the '#' character.
399 //
400 // When modifying this condition, please take a look at:
danakjd83d706d2020-11-25 22:11:12401 // FrameLoader::ShouldPerformFragmentNavigation().
clamyea99ea12018-05-28 13:54:23402 //
403 // Note: this check is only valid for navigations that are not history
404 // navigations. For instance, if the history is: 'A#bar' -> 'B' -> 'A#foo', a
405 // history navigation from 'A#foo' to 'A#bar' is not a same-document
406 // navigation, but a different-document one. This is why history navigation
407 // are classified before this check.
Lei Zhang96031532019-10-10 19:05:47408 bool is_same_doc = new_url.has_ref() && old_url.EqualsIgnoringRef(new_url) &&
409 frame_entry.method() == "GET";
danakjd83d706d2020-11-25 22:11:12410
411 // The one case where we do the wrong thing here and incorrectly choose
412 // SAME_DOCUMENT is if the navigation is browser-initiated but the document in
413 // the renderer is a frameset. All frameset navigations should be
414 // DIFFERENT_DOCUMENT, even if their URLs match. A renderer-initiated
415 // navigation would do the right thing, as it would send it to the browser and
416 // all renderer-initiated navigations are DIFFERENT_DOCUMENT (they don't get
417 // into this method). But since we can't tell that case here for browser-
418 // initiated navigations, we have to get the renderer involved. In that case
419 // the navigation would be restarted due to the renderer spending a reply of
420 // mojom::CommitResult::RestartCrossDocument.
421
422 return can_be_same_document && is_same_doc
Minggang Wangb9f3fa92021-07-01 15:30:31423 ? blink::mojom::NavigationType::SAME_DOCUMENT
424 : blink::mojom::NavigationType::DIFFERENT_DOCUMENT;
clamyea99ea12018-05-28 13:54:23425}
426
Camille Lamy5193caa2018-10-12 11:59:42427// Adjusts the original input URL if needed, to get the URL to actually load and
428// the virtual URL, which may differ.
429void RewriteUrlForNavigation(const GURL& original_url,
430 BrowserContext* browser_context,
431 GURL* url_to_load,
432 GURL* virtual_url,
433 bool* reverse_on_redirect) {
Camille Lamy5193caa2018-10-12 11:59:42434 // Allow the browser URL handler to rewrite the URL. This will, for example,
435 // remove "view-source:" from the beginning of the URL to get the URL that
436 // will actually be loaded. This real URL won't be shown to the user, just
437 // used internally.
Lukasz Anforowicz7b078792020-10-20 17:04:31438 *url_to_load = *virtual_url = original_url;
Camille Lamy5193caa2018-10-12 11:59:42439 BrowserURLHandlerImpl::GetInstance()->RewriteURLIfNecessary(
440 url_to_load, browser_context, reverse_on_redirect);
441}
442
443#if DCHECK_IS_ON()
444// Helper sanity check function used in debug mode.
445void ValidateRequestMatchesEntry(NavigationRequest* request,
446 NavigationEntryImpl* entry) {
447 if (request->frame_tree_node()->IsMainFrame()) {
448 DCHECK_EQ(request->browser_initiated(), !entry->is_renderer_initiated());
449 DCHECK(ui::PageTransitionTypeIncludingQualifiersIs(
Minggang Wangb9f3fa92021-07-01 15:30:31450 ui::PageTransitionFromInt(request->common_params().transition),
451 entry->GetTransitionType()));
Camille Lamy5193caa2018-10-12 11:59:42452 }
Nasko Oskovc36327d2019-01-03 23:23:04453 DCHECK_EQ(request->commit_params().should_clear_history_list,
Camille Lamy5193caa2018-10-12 11:59:42454 entry->should_clear_history_list());
455 DCHECK_EQ(request->common_params().has_user_gesture,
456 entry->has_user_gesture());
457 DCHECK_EQ(request->common_params().base_url_for_data_url,
458 entry->GetBaseURLForDataURL());
Nasko Oskovc36327d2019-01-03 23:23:04459 DCHECK_EQ(request->commit_params().can_load_local_resources,
Camille Lamy5193caa2018-10-12 11:59:42460 entry->GetCanLoadLocalResources());
461 DCHECK_EQ(request->common_params().started_from_context_menu,
462 entry->has_started_from_context_menu());
463
464 FrameNavigationEntry* frame_entry =
465 entry->GetFrameEntry(request->frame_tree_node());
466 if (!frame_entry) {
Peter Boström8472105d2024-05-15 04:36:02467 NOTREACHED_IN_MIGRATION();
Camille Lamy5193caa2018-10-12 11:59:42468 return;
469 }
470
Camille Lamy5193caa2018-10-12 11:59:42471 DCHECK_EQ(request->common_params().method, frame_entry->method());
472
Nasko Oskovc36327d2019-01-03 23:23:04473 size_t redirect_size = request->commit_params().redirects.size();
Camille Lamy5193caa2018-10-12 11:59:42474 if (redirect_size == frame_entry->redirect_chain().size()) {
475 for (size_t i = 0; i < redirect_size; ++i) {
Nasko Oskovc36327d2019-01-03 23:23:04476 DCHECK_EQ(request->commit_params().redirects[i],
Camille Lamy5193caa2018-10-12 11:59:42477 frame_entry->redirect_chain()[i]);
478 }
479 } else {
Peter Boström8472105d2024-05-15 04:36:02480 NOTREACHED_IN_MIGRATION();
Camille Lamy5193caa2018-10-12 11:59:42481 }
482}
483#endif // DCHECK_IS_ON()
484
Dave Tapuska8bfd84c2019-03-26 20:47:16485// Returns whether the session history NavigationRequests in |navigations|
Nate Chapinbf682fa32022-09-26 22:41:20486// would stay within the subtree of |sandboxed_initiator_rfh|.
Dave Tapuska8bfd84c2019-03-26 20:47:16487bool DoesSandboxNavigationStayWithinSubtree(
Nate Chapinbf682fa32022-09-26 22:41:20488 RenderFrameHostImpl* sandboxed_initiator_rfh,
Dave Tapuska8bfd84c2019-03-26 20:47:16489 const std::vector<std::unique_ptr<NavigationRequest>>& navigations) {
Nate Chapinbf682fa32022-09-26 22:41:20490 DCHECK(sandboxed_initiator_rfh);
491 DCHECK(sandboxed_initiator_rfh->IsSandboxed(
492 network::mojom::WebSandboxFlags::kTopNavigation));
Dave Tapuska8bfd84c2019-03-26 20:47:16493 for (auto& item : navigations) {
494 bool within_subtree = false;
495 // Check whether this NavigationRequest affects a frame within the
496 // sandboxed frame's subtree by walking up the tree looking for the
497 // sandboxed frame.
498 for (auto* frame = item->frame_tree_node(); frame;
Alexander Timin381e7e182020-04-28 19:04:03499 frame = FrameTreeNode::From(frame->parent())) {
Nate Chapinbf682fa32022-09-26 22:41:20500 if (frame == sandboxed_initiator_rfh->frame_tree_node()) {
Dave Tapuska8bfd84c2019-03-26 20:47:16501 within_subtree = true;
502 break;
503 }
504 }
505 if (!within_subtree)
506 return false;
507 }
508 return true;
509}
510
William Liu122754942024-01-18 22:34:39511// Used for "Navigation.SessionHistoryCount" histogram.
512enum class HistoryNavTypeForHistogram {
513 // A same-doc or cross-doc navigation of the main frame. We can only have one
514 // main frame request per `NavigationController::GoToIndex()`.
515 kMainFrame = 0,
516 // `NavigationController::GoToIndex()` creates one main frame request and
517 // one or more subframe requests.
518 kMainFrameAndSubframe,
519 // `NavigationController::GoToIndex()` creates one or more subframe requests.
520 kSubframe,
521 // Used for histogram boundary.
522 kCount
523};
524
525void CountRequests(
526 const std::vector<std::unique_ptr<NavigationRequest>>& requests,
527 int& mutable_main_frame_cnt,
528 int& mutable_subframe_cnt) {
529 for (const auto& req : requests) {
530 if (req->IsInPrimaryMainFrame()) {
531 // We can only have one main frame navigation at a time.
532 CHECK_EQ(mutable_main_frame_cnt, 0);
533 ++mutable_main_frame_cnt;
534 } else if (req->GetNavigatingFrameType() == FrameType::kSubframe) {
535 ++mutable_subframe_cnt;
536 }
537 }
538}
539
540// Record the number of different types of navigations as histograms. See
541// `HistoryNavTypeForHistogram` for the types.
542void CountBrowserInitiatedMainframeAndSubframeHistoryNavigaions(
543 const std::vector<std::unique_ptr<NavigationRequest>>& cross_doc_requests,
544 const std::vector<std::unique_ptr<NavigationRequest>>& same_doc_requests) {
545 // We must have one request.
546 CHECK(!cross_doc_requests.empty() || !same_doc_requests.empty());
547
548 int main_frame_cnt = 0;
549 int subframe_cnt = 0;
550 CountRequests(cross_doc_requests, main_frame_cnt, subframe_cnt);
551 CountRequests(same_doc_requests, main_frame_cnt, subframe_cnt);
552
553 std::optional<HistoryNavTypeForHistogram> history_nav_type;
554 if (main_frame_cnt > 0) {
555 if (subframe_cnt == 0) {
556 history_nav_type = HistoryNavTypeForHistogram::kMainFrame;
557 } else {
558 history_nav_type = HistoryNavTypeForHistogram::kMainFrameAndSubframe;
559 }
560 } else if (subframe_cnt > 0) {
561 history_nav_type = HistoryNavTypeForHistogram::kSubframe;
562 }
563 if (history_nav_type.has_value()) {
564 UMA_HISTOGRAM_ENUMERATION("Navigation.BrowserInitiatedSessionHistoryCount",
565 history_nav_type.value(),
566 HistoryNavTypeForHistogram::kCount);
567 }
568}
569
[email protected]e9ba4472008-09-14 15:42:43570} // namespace
571
arthursonzogni66f711c2019-10-08 14:40:36572// NavigationControllerImpl::PendingEntryRef------------------------------------
573
574NavigationControllerImpl::PendingEntryRef::PendingEntryRef(
575 base::WeakPtr<NavigationControllerImpl> controller)
576 : controller_(controller) {}
577
578NavigationControllerImpl::PendingEntryRef::~PendingEntryRef() {
579 if (!controller_) // Can be null with interstitials.
580 return;
581
582 controller_->PendingEntryRefDeleted(this);
583}
584
[email protected]d202a7c2012-01-04 07:53:47585// NavigationControllerImpl ----------------------------------------------------
initial.commit09911bf2008-07-26 23:55:29586
[email protected]23a918b2014-07-15 09:51:36587const size_t kMaxEntryCountForTestingNotSet = static_cast<size_t>(-1);
[email protected]9b51970d2011-12-09 23:10:23588
[email protected]765b35502008-08-21 00:51:20589// static
[email protected]d202a7c2012-01-04 07:53:47590size_t NavigationControllerImpl::max_entry_count_for_testing_ =
[email protected]9b51970d2011-12-09 23:10:23591 kMaxEntryCountForTestingNotSet;
[email protected]765b35502008-08-21 00:51:20592
[email protected]e6fec472013-05-14 05:29:02593// Should Reload check for post data? The default is true, but is set to false
[email protected]cdcb1dee2012-01-04 00:46:20594// when testing.
595static bool g_check_for_repost = true;
initial.commit09911bf2008-07-26 23:55:29596
[email protected]71fde352011-12-29 03:29:56597// static
dcheng9bfa5162016-04-09 01:00:57598std::unique_ptr<NavigationEntry> NavigationController::CreateNavigationEntry(
599 const GURL& url,
Lukasz Anforowicz641234d52019-11-07 21:07:10600 Referrer referrer,
Arthur Sonzognic686e8f2024-01-11 08:36:37601 std::optional<url::Origin> initiator_origin,
602 std::optional<GURL> initiator_base_url,
Lukasz Anforowicz641234d52019-11-07 21:07:10603 ui::PageTransition transition,
604 bool is_renderer_initiated,
605 const std::string& extra_headers,
606 BrowserContext* browser_context,
607 scoped_refptr<network::SharedURLLoaderFactory> blob_url_loader_factory) {
608 return NavigationControllerImpl::CreateNavigationEntry(
W. James MacLean23e90a12022-12-21 04:38:21609 url, referrer, std::move(initiator_origin), std::move(initiator_base_url),
Arthur Sonzognic686e8f2024-01-11 08:36:37610 std::nullopt /* source_process_site_url */, transition,
Sharon Yang242ef822023-05-15 21:07:32611 is_renderer_initiated, extra_headers, browser_context,
612 std::move(blob_url_loader_factory), true /* rewrite_virtual_urls */);
Lukasz Anforowicz641234d52019-11-07 21:07:10613}
614
615// static
616std::unique_ptr<NavigationEntryImpl>
617NavigationControllerImpl::CreateNavigationEntry(
618 const GURL& url,
619 Referrer referrer,
Arthur Sonzognic686e8f2024-01-11 08:36:37620 std::optional<url::Origin> initiator_origin,
621 std::optional<GURL> initiator_base_url,
622 std::optional<GURL> source_process_site_url,
dcheng9bfa5162016-04-09 01:00:57623 ui::PageTransition transition,
624 bool is_renderer_initiated,
625 const std::string& extra_headers,
Marijn Kruisselbrink7a0d5e182018-05-24 22:55:09626 BrowserContext* browser_context,
Julie Jeongeun Kim5b9aff72022-05-02 02:10:17627 scoped_refptr<network::SharedURLLoaderFactory> blob_url_loader_factory,
628 bool rewrite_virtual_urls) {
629 GURL url_to_load = url;
630 GURL virtual_url = url;
[email protected]71fde352011-12-29 03:29:56631 bool reverse_on_redirect = false;
Julie Jeongeun Kim5b9aff72022-05-02 02:10:17632 if (rewrite_virtual_urls) {
633 RewriteUrlForNavigation(url, browser_context, &url_to_load, &virtual_url,
634 &reverse_on_redirect);
635 }
Lukasz Anforowicz641234d52019-11-07 21:07:10636 // Let the NTP override the navigation params and pretend that this is a
637 // browser-initiated, bookmark-like navigation.
638 GetContentClient()->browser()->OverrideNavigationParams(
Sharon Yang242ef822023-05-15 21:07:32639 source_process_site_url, &transition, &is_renderer_initiated, &referrer,
Scott Violetcf6ea7e2021-06-09 21:09:21640 &initiator_origin);
Lukasz Anforowicz641234d52019-11-07 21:07:10641
Patrick Monettef507e982019-06-19 20:18:06642 auto entry = std::make_unique<NavigationEntryImpl>(
Ivan Kotenkov2c0d2bb32017-11-01 15:41:28643 nullptr, // The site instance for tabs is sent on navigation
644 // (WebContents::GetSiteInstance).
W. James MacLean23e90a12022-12-21 04:38:21645 url_to_load, referrer, initiator_origin, initiator_base_url,
646 std::u16string(), transition, is_renderer_initiated,
647 blob_url_loader_factory,
Rakina Zata Amniafd3c6582021-11-30 06:19:17648 /* is_initial_entry = */ false);
Camille Lamy5193caa2018-10-12 11:59:42649 entry->SetVirtualURL(virtual_url);
650 entry->set_user_typed_url(virtual_url);
[email protected]71fde352011-12-29 03:29:56651 entry->set_update_virtual_url_with_url(reverse_on_redirect);
652 entry->set_extra_headers(extra_headers);
Patrick Monettef507e982019-06-19 20:18:06653 return entry;
[email protected]71fde352011-12-29 03:29:56654}
655
[email protected]cdcb1dee2012-01-04 00:46:20656// static
657void NavigationController::DisablePromptOnRepost() {
658 g_check_for_repost = false;
659}
660
[email protected]c5b88d82012-10-06 17:03:33661base::Time NavigationControllerImpl::TimeSmoother::GetSmoothedTime(
662 base::Time t) {
663 // If |t| is between the water marks, we're in a run of duplicates
664 // or just getting out of it, so increase the high-water mark to get
665 // a time that probably hasn't been used before and return it.
666 if (low_water_mark_ <= t && t <= high_water_mark_) {
Peter Kastinge5a38ed2021-10-02 03:06:35667 high_water_mark_ += base::Microseconds(1);
[email protected]c5b88d82012-10-06 17:03:33668 return high_water_mark_;
669 }
670
671 // Otherwise, we're clear of the last duplicate run, so reset the
672 // water marks.
673 low_water_mark_ = high_water_mark_ = t;
674 return t;
675}
676
ckitagawa0faa5e42020-06-17 17:30:54677NavigationControllerImpl::ScopedShowRepostDialogForTesting::
678 ScopedShowRepostDialogForTesting()
679 : was_disallowed_(g_check_for_repost) {
680 g_check_for_repost = true;
681}
682
683NavigationControllerImpl::ScopedShowRepostDialogForTesting::
684 ~ScopedShowRepostDialogForTesting() {
685 g_check_for_repost = was_disallowed_;
686}
687
Nate Chapin9eb16be72022-09-23 22:54:31688NavigationControllerImpl::RemovedEntriesTracker::RemovedEntriesTracker(
689 base::SafeRef<NavigationControllerImpl> controller)
690 : controller_(controller) {
691 for (FrameTreeNode* frame_tree_node : controller_->frame_tree().Nodes()) {
692 names_to_nodes_.insert({frame_tree_node->unique_name(), frame_tree_node});
693 frame_tree_node_id_to_keys_.insert(
694 {frame_tree_node->frame_tree_node_id(), std::set<std::string>()});
695 if (auto* frame_entry = frame_tree_node->current_frame_host()
696 ->last_committed_frame_entry()) {
697 frame_tree_node_id_to_doc_seq_nos_.insert(
698 {frame_tree_node->frame_tree_node_id(),
699 frame_entry->document_sequence_number()});
700 }
701 }
702 PopulateKeySet(Direction::kBack);
703 PopulateKeySet(Direction::kForward);
704}
705
706void NavigationControllerImpl::RemovedEntriesTracker::PopulateKeySet(
707 Direction direction) {
708 // Keep track of which FrameTreeNodes may still have relevant API keys in
709 // additional FrameNavigationEntries.
710 std::set<FrameTreeNode*> nodes_to_process;
711 for (FrameTreeNode* node : controller_->frame_tree().Nodes()) {
712 nodes_to_process.insert(node);
713 }
714
715 const int offset = direction == Direction::kForward ? 1 : -1;
716 const int start = direction == Direction::kForward
717 ? controller_->GetLastCommittedEntryIndex()
718 : controller_->GetLastCommittedEntryIndex() - 1;
719 for (int i = start;
720 i >= 0 && i < controller_->GetEntryCount() && !nodes_to_process.empty();
721 i += offset) {
722 std::set<FrameTreeNode*> nodes_to_continue_processing;
723
724 NavigationEntryImpl* entry = controller_->GetEntryAtIndex(i);
725 entry->ForEachFrameEntry([this, &nodes_to_process,
726 &nodes_to_continue_processing,
727 &entry](FrameNavigationEntry* frame_entry) {
728 // Find the |node| that matches |frame_entry|, if any.
729 FrameTreeNode* node = nullptr;
730 if (frame_entry == entry->root_node()->frame_entry) {
731 node = controller_->frame_tree().root();
732 } else {
733 auto it = names_to_nodes_.find(frame_entry->frame_unique_name());
734 if (it == names_to_nodes_.end())
735 return;
736 node = it->second;
737 }
738
739 // Skip this node if a previous step determine there are no longer
740 // relevant navigation API keys in this direction.
741 if (nodes_to_process.find(node) == nodes_to_process.end())
742 return;
743
744 // Stop processing |node| if we reach a point where it's cross-origin.
745 // See also PopulateSingleNavigationApiHistoryEntryVector().
746 url::Origin frame_entry_origin =
747 frame_entry->committed_origin().value_or(url::Origin::Resolve(
748 frame_entry->url(),
749 frame_entry->initiator_origin().value_or(url::Origin())));
750 if (!node->current_origin().IsSameOriginWith(frame_entry_origin))
751 return;
752
753 frame_tree_node_id_to_keys_[node->frame_tree_node_id()].insert(
754 frame_entry->navigation_api_key());
755 // Mark |node| as needing more processing for the next entry.
756 nodes_to_continue_processing.insert(node);
757
758 // Check whether |node| went cross-document. If so, its children are
759 // no longer the same conceptual iframe as the current one, and
760 // should no longer be processed. This check is intentionally done
761 // after processing the current |node|, which may still have relevant
762 // discarded API keys.
763 if (frame_entry->document_sequence_number() !=
764 frame_tree_node_id_to_doc_seq_nos_[node->frame_tree_node_id()]) {
Arthur Sonzognif6785ec2022-12-05 10:11:50765 for (auto* descendant : node->frame_tree().SubtreeNodes(node))
Nate Chapin9eb16be72022-09-23 22:54:31766 nodes_to_process.erase(descendant);
767 }
768 });
769
770 nodes_to_process.swap(nodes_to_continue_processing);
771 }
772}
773
774NavigationControllerImpl::RemovedEntriesTracker::~RemovedEntriesTracker() {
775 std::set<std::string> all_keys;
776 // Find all remaining navigation API keys after some entries have been
777 // removed.
778 for (auto& entry : controller_->entries_) {
779 entry->ForEachFrameEntry([&all_keys](FrameNavigationEntry* frame_entry) {
780 all_keys.insert(frame_entry->navigation_api_key());
781 });
782 }
783
784 // Notify each frame in the renderer of any disposed navigation API keys.
785 for (auto& id_to_keys : frame_tree_node_id_to_keys_) {
786 std::vector<std::string> disposed_keys;
787 for (const auto& key : id_to_keys.second) {
788 if (all_keys.find(key) == all_keys.end())
789 disposed_keys.push_back(key);
790 }
791 if (disposed_keys.empty())
792 continue;
793
794 FrameTreeNode* node = controller_->frame_tree().FindByID(id_to_keys.first);
795 auto& frame = node->current_frame_host()->GetAssociatedLocalFrame();
796 frame->NotifyNavigationApiOfDisposedEntries(disposed_keys);
797 }
798}
799
[email protected]d202a7c2012-01-04 07:53:47800NavigationControllerImpl::NavigationControllerImpl(
Carlos Caballero40b0efd2021-01-26 11:55:00801 BrowserContext* browser_context,
802 FrameTree& frame_tree,
803 NavigationControllerDelegate* delegate)
804 : frame_tree_(frame_tree),
805 browser_context_(browser_context),
[email protected]ec6c05f2013-10-23 18:41:57806 delegate_(delegate),
[email protected]69e797f2013-04-30 01:10:22807 ssl_manager_(this),
Mingyu Lei68f34412023-08-21 07:31:37808 get_timestamp_callback_(base::BindRepeating(&base::Time::Now)),
809 back_forward_cache_(browser_context) {
[email protected]3d7474ff2011-07-27 17:47:37810 DCHECK(browser_context_);
initial.commit09911bf2008-07-26 23:55:29811}
812
[email protected]d202a7c2012-01-04 07:53:47813NavigationControllerImpl::~NavigationControllerImpl() {
arthursonzogni69a6a1b2019-09-17 09:23:00814 // The NavigationControllerImpl might be called inside its delegate
815 // destructor. Calling it is not valid anymore.
816 delegate_ = nullptr;
817 DiscardNonCommittedEntries();
initial.commit09911bf2008-07-26 23:55:29818}
819
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57820BrowserContext* NavigationControllerImpl::GetBrowserContext() {
[email protected]a26023822011-12-29 00:23:55821 return browser_context_;
822}
823
[email protected]d202a7c2012-01-04 07:53:47824void NavigationControllerImpl::Restore(
[email protected]5e369672009-11-03 23:48:30825 int selected_navigation,
[email protected]2ca1ea662012-10-04 02:26:36826 RestoreType type,
dcheng9bfa5162016-04-09 01:00:57827 std::vector<std::unique_ptr<NavigationEntry>>* entries) {
Charlie Reis23c26da2022-01-29 00:57:47828 // Note that it's possible for `entries_` to contain multiple entries at this
829 // point, as Restore() might be called on a NavigationController that is
830 // already used (e.g. due to WebView's restoreState() API), not only for fresh
831 // NavigationControllers. These entries are not cleared to preserve legacy
832 // behavior and also because `pending_entry_` might point to one of the
833 // pre-existing entries. An exception for this is when `entries_` contains
834 // only the initial NavigationEntry, which must be removed.
835
836 // Do not proceed if selected_navigation will be out of bounds for the updated
837 // entries_ list, since it will be assigned to last_committed_entry_index_ and
838 // used to index entries_.
Alison Gale770f3fc2024-04-27 00:39:58839 // TODO(crbug.com/40816356): Consider also returning early if entries
Charlie Reis23c26da2022-01-29 00:57:47840 // is empty, since there should be no work to do (rather than marking the
841 // existing entries as needing reload). Also consider returning early if the
842 // selected index is -1, which represents a no-committed-entry state.
843 if (selected_navigation < -1 ||
844 selected_navigation >=
845 base::checked_cast<int>(entries->size() + entries_.size())) {
846 return;
Rakina Zata Amni2322f4f82022-01-24 13:24:24847 }
Charlie Reis23c26da2022-01-29 00:57:47848
Rakina Zata Amni46087a12022-11-11 08:28:38849 // There will always be at least one entry (new NavigationControllers will
850 // have the initial NavigationEntry).
851 if (selected_navigation == -1)
852 selected_navigation = 0;
Charlie Reis23c26da2022-01-29 00:57:47853
Rakina Zata Amni46087a12022-11-11 08:28:38854 if (GetLastCommittedEntry()->IsInitialEntry() && entries->size() > 0) {
855 // If we are on the initial NavigationEntry, it must be the only entry in
856 // the list. Since it's impossible to do a history navigation to the
857 // initial NavigationEntry, `pending_entry_index_` must be -1 (but
858 // `pending_entry` might be set for a new non-history navigation).
859 // Note that we should not clear `entries_` if `entries` is empty (when
860 // InitialNavigationEntry mode is enabled), since that would leave us
861 // without any NavigationEntry.
862 CHECK_EQ(1, GetEntryCount());
863 CHECK_EQ(-1, pending_entry_index_);
864 entries_.clear();
Charlie Reis23c26da2022-01-29 00:57:47865 }
[email protected]ce3fa3c2009-04-20 19:55:57866
[email protected]ce3fa3c2009-04-20 19:55:57867 needs_reload_ = true;
Bo Liucdfa4b12018-11-06 00:21:44868 needs_reload_type_ = NeedsReloadType::kRestoreSession;
avif16f85a72015-11-13 18:25:03869 entries_.reserve(entries->size());
Charlie Reis23c26da2022-01-29 00:57:47870 for (auto& entry : *entries) {
Rakina Zata Amni996ee412022-02-17 04:51:43871 if (entry->GetURL().is_empty()) {
872 // We're trying to restore an entry with an empty URL (e.g. from
Rakina Zata Amni2729a512022-03-16 05:54:01873 // persisting the initial NavigationEntry [which is no longer possible but
874 // some old persisted sessions might still contain it] or when the
875 // serializer failed to write the URL because it's too long). Trying to
876 // restore and navigate to an entry with an empty URL will result in
877 // crashes, so change the URL to about:blank. See also
878 // https://crbug.com/1240138 and https://crbug.com/1299335.
Rakina Zata Amni996ee412022-02-17 04:51:43879 entry->SetURL(GURL(url::kAboutBlankURL));
880 }
dcheng36b6aec92015-12-26 06:16:36881 entries_.push_back(
882 NavigationEntryImpl::FromNavigationEntry(std::move(entry)));
Charlie Reis23c26da2022-01-29 00:57:47883 }
avif16f85a72015-11-13 18:25:03884
885 // At this point, the |entries| is full of empty scoped_ptrs, so it can be
886 // cleared out safely.
887 entries->clear();
[email protected]ce3fa3c2009-04-20 19:55:57888
889 // And finish the restore.
[email protected]2ca1ea662012-10-04 02:26:36890 FinishRestore(selected_navigation, type);
[email protected]ce3fa3c2009-04-20 19:55:57891}
892
toyoshim6142d96f2016-12-19 09:07:25893void NavigationControllerImpl::Reload(ReloadType reload_type,
894 bool check_for_repost) {
Rakina Zata Amnid605d462022-06-01 10:17:03895 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy_caller1", "Reload_type",
896 (int)reload_type);
897 SCOPED_CRASH_KEY_BOOL("nav_reentrancy_caller1", "Reload_check",
898 check_for_repost);
liaoyuke9168fba2017-03-10 19:20:28899 DCHECK_NE(ReloadType::NONE, reload_type);
Ivan Kotenkov2c0d2bb32017-11-01 15:41:28900 NavigationEntryImpl* entry = nullptr;
[email protected]59167c22013-06-03 18:07:32901 int current_index = -1;
902
Carlos IL42b416592019-10-07 23:10:36903 if (entry_replaced_by_post_commit_error_) {
904 // If there is an entry that was replaced by a currently active post-commit
905 // error navigation, this can't be the initial navigation.
906 DCHECK(!IsInitialNavigation());
907 // If the current entry is a post commit error, we reload the entry it
908 // replaced instead. We leave the error entry in place until a commit
909 // replaces it, but the pending entry points to the original entry in the
910 // meantime. Note that NavigateToExistingPendingEntry is able to handle the
911 // case that pending_entry_ != entries_[pending_entry_index_].
912 entry = entry_replaced_by_post_commit_error_.get();
913 current_index = GetCurrentEntryIndex();
914 } else if (IsInitialNavigation() && pending_entry_) {
915 // If we are reloading the initial navigation, just use the current
916 // pending entry. Otherwise look up the current entry.
[email protected]59167c22013-06-03 18:07:32917 entry = pending_entry_;
918 // The pending entry might be in entries_ (e.g., after a Clone), so we
919 // should also update the current_index.
920 current_index = pending_entry_index_;
921 } else {
arthursonzogni69a6a1b2019-09-17 09:23:00922 DiscardNonCommittedEntries();
[email protected]59167c22013-06-03 18:07:32923 current_index = GetCurrentEntryIndex();
924 if (current_index != -1) {
creis3da03872015-02-20 21:12:32925 entry = GetEntryAtIndex(current_index);
[email protected]59167c22013-06-03 18:07:32926 }
[email protected]979a4bc2013-04-24 01:27:15927 }
[email protected]241db352013-04-22 18:04:05928
[email protected]59167c22013-06-03 18:07:32929 // If we are no where, then we can't reload. TODO(darin): We should add a
930 // CanReload method.
931 if (!entry)
932 return;
933
Rakina Zata Amnif297a802022-01-18 03:53:43934 if (entry->IsInitialEntryNotForSynchronousAboutBlank()) {
935 // We should never navigate to an existing initial NavigationEntry that is
936 // the initial NavigationEntry for the initial empty document that hasn't
937 // been overridden by the synchronous about:blank commit, to preserve
938 // legacy behavior where trying to reload when the main frame is on the
939 // initial empty document won't result in a navigation. See also
940 // https://crbug.com/1277414.
941 return;
942 }
943
Aran Gilman37d11632019-10-08 23:07:15944 if (g_check_for_repost && check_for_repost && entry->GetHasPostData()) {
[email protected]a3a1d142008-12-19 00:42:30945 // The user is asking to reload a page with POST data. Prompt to make sure
[email protected]b5bb35f2009-02-05 20:17:07946 // they really want to do this. If they do, the dialog will call us back
947 // with check_for_repost = false.
[email protected]ec6c05f2013-10-23 18:41:57948 delegate_->NotifyBeforeFormRepostWarningShow();
[email protected]965bb092010-04-09 11:59:02949
[email protected]106a0812010-03-18 00:15:12950 pending_reload_ = reload_type;
[email protected]ec6c05f2013-10-23 18:41:57951 delegate_->ActivateAndShowRepostFormWarningDialog();
Lei Zhang96031532019-10-10 19:05:47952 return;
initial.commit09911bf2008-07-26 23:55:29953 }
Lei Zhang96031532019-10-10 19:05:47954
Wang Huia25efabc2022-09-24 17:27:22955 // Set ReloadType for |entry|.
956 entry->set_reload_type(reload_type);
957
Lei Zhang96031532019-10-10 19:05:47958 if (!IsInitialNavigation())
959 DiscardNonCommittedEntries();
960
961 pending_entry_ = entry;
962 pending_entry_index_ = current_index;
963 pending_entry_->SetTransitionType(ui::PAGE_TRANSITION_RELOAD);
964
Nate Chapin45f620582021-09-30 17:45:43965 // location.reload() goes through BeginNavigation, so all reloads triggered
966 // via this codepath are browser initiated.
Yoav Weiss8c573952022-11-17 17:35:13967 NavigateToExistingPendingEntry(
968 reload_type,
969 /*initiator_rfh=*/nullptr,
Arthur Sonzognic686e8f2024-01-11 08:36:37970 /*soft_navigation_heuristics_task_id=*/std::nullopt,
Yoav Weiss8c573952022-11-17 17:35:13971 /*navigation_api_key=*/nullptr);
initial.commit09911bf2008-07-26 23:55:29972}
973
[email protected]d202a7c2012-01-04 07:53:47974void NavigationControllerImpl::CancelPendingReload() {
toyoshim0df1d3a2016-09-09 09:52:48975 pending_reload_ = ReloadType::NONE;
[email protected]106a0812010-03-18 00:15:12976}
977
[email protected]d202a7c2012-01-04 07:53:47978void NavigationControllerImpl::ContinuePendingReload() {
Wang Hui96ab1012022-10-11 02:05:49979 // If the pending reload type has been cleared by another navigation
980 // committing, then do not proceed to reload after a form repost dialog.
toyoshim0df1d3a2016-09-09 09:52:48981 if (pending_reload_ == ReloadType::NONE) {
Wang Hui96ab1012022-10-11 02:05:49982 return;
[email protected]106a0812010-03-18 00:15:12983 }
Wang Hui96ab1012022-10-11 02:05:49984 Reload(pending_reload_, false);
985 pending_reload_ = ReloadType::NONE;
[email protected]106a0812010-03-18 00:15:12986}
987
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57988bool NavigationControllerImpl::IsInitialNavigation() {
[email protected]27ba81c2012-08-21 17:04:09989 return is_initial_navigation_;
[email protected]c70f9b82010-04-21 07:31:11990}
991
Lucas Furukawa Gadani5553a1582019-01-08 18:55:57992bool NavigationControllerImpl::IsInitialBlankNavigation() {
Rakina Zata Amni46087a12022-11-11 08:28:38993 // Check that we're on the initial NavigationEntry and that this is not a
994 // cloned tab.
995 return IsInitialNavigation() && GetEntryCount() == 1 &&
996 GetLastCommittedEntry()->IsInitialEntry() &&
997 GetLastCommittedEntry()->restore_type() == RestoreType::kNotRestored;
creis10a4ab72015-10-13 17:22:40998}
999
Aran Gilman37d11632019-10-08 23:07:151000NavigationEntryImpl* NavigationControllerImpl::GetEntryWithUniqueID(
1001 int nav_entry_id) const {
avi254eff02015-07-01 08:27:581002 int index = GetEntryIndexWithUniqueID(nav_entry_id);
avif16f85a72015-11-13 18:25:031003 return (index != -1) ? entries_[index].get() : nullptr;
avi254eff02015-07-01 08:27:581004}
1005
Adithya Srinivasan9b0c99c2021-08-10 15:19:451006NavigationEntryImpl*
1007NavigationControllerImpl::GetEntryWithUniqueIDIncludingPending(
1008 int nav_entry_id) const {
1009 NavigationEntryImpl* entry = GetEntryWithUniqueID(nav_entry_id);
1010 if (entry)
1011 return entry;
1012 return pending_entry_ && pending_entry_->GetUniqueID() == nav_entry_id
Keishi Hattori0e45c022021-11-27 09:25:521013 ? pending_entry_.get()
Adithya Srinivasan9b0c99c2021-08-10 15:19:451014 : nullptr;
1015}
1016
W. James MacLeanc07dc41b2022-07-25 18:52:161017void NavigationControllerImpl::RegisterExistingOriginAsHavingDefaultIsolation(
W. James MacLean1c40862c2020-04-27 21:05:571018 const url::Origin& origin) {
1019 for (int i = 0; i < GetEntryCount(); i++) {
1020 auto* entry = GetEntryAtIndex(i);
W. James MacLeanc07dc41b2022-07-25 18:52:161021 entry->RegisterExistingOriginAsHavingDefaultIsolation(origin);
W. James MacLean1c40862c2020-04-27 21:05:571022 }
1023 if (entry_replaced_by_post_commit_error_) {
1024 // It's possible we could come back to this entry if the error
1025 // page/interstitial goes away.
1026 entry_replaced_by_post_commit_error_
W. James MacLeanc07dc41b2022-07-25 18:52:161027 ->RegisterExistingOriginAsHavingDefaultIsolation(origin);
W. James MacLean1c40862c2020-04-27 21:05:571028 }
W. James MacLean1c40862c2020-04-27 21:05:571029}
1030
avi25764702015-06-23 15:43:371031void NavigationControllerImpl::SetPendingEntry(
dcheng9bfa5162016-04-09 01:00:571032 std::unique_ptr<NavigationEntryImpl> entry) {
arthursonzogni69a6a1b2019-09-17 09:23:001033 DiscardNonCommittedEntries();
avi25764702015-06-23 15:43:371034 pending_entry_ = entry.release();
arthursonzogni5c4c202d2017-04-25 23:41:271035 DCHECK_EQ(-1, pending_entry_index_);
[email protected]765b35502008-08-21 00:51:201036}
1037
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571038NavigationEntryImpl* NavigationControllerImpl::GetActiveEntry() {
[email protected]cbab76d2008-10-13 22:42:471039 if (pending_entry_)
1040 return pending_entry_;
1041 return GetLastCommittedEntry();
[email protected]765b35502008-08-21 00:51:201042}
1043
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571044NavigationEntryImpl* NavigationControllerImpl::GetVisibleEntry() {
[email protected]59167c22013-06-03 18:07:321045 // The pending entry is safe to return for new (non-history), browser-
1046 // initiated navigations. Most renderer-initiated navigations should not
1047 // show the pending entry, to prevent URL spoof attacks.
1048 //
1049 // We make an exception for renderer-initiated navigations in new tabs, as
1050 // long as no other page has tried to access the initial empty document in
1051 // the new tab. If another page modifies this blank page, a URL spoof is
1052 // possible, so we must stop showing the pending entry.
[email protected]59167c22013-06-03 18:07:321053 bool safe_to_show_pending =
1054 pending_entry_ &&
1055 // Require a new navigation.
avi0dca04d2015-01-26 20:21:091056 pending_entry_index_ == -1 &&
[email protected]59167c22013-06-03 18:07:321057 // Require either browser-initiated or an unmodified new tab.
[email protected]aa62afd2014-04-22 19:22:461058 (!pending_entry_->is_renderer_initiated() || IsUnmodifiedBlankTab());
[email protected]59167c22013-06-03 18:07:321059
1060 // Also allow showing the pending entry for history navigations in a new tab,
1061 // such as Ctrl+Back. In this case, no existing page is visible and no one
1062 // can script the new tab before it commits.
Aran Gilman37d11632019-10-08 23:07:151063 if (!safe_to_show_pending && pending_entry_ && pending_entry_index_ != -1 &&
1064 IsInitialNavigation() && !pending_entry_->is_renderer_initiated())
[email protected]59167c22013-06-03 18:07:321065 safe_to_show_pending = true;
1066
1067 if (safe_to_show_pending)
[email protected]867e1f92011-08-30 19:01:191068 return pending_entry_;
1069 return GetLastCommittedEntry();
1070}
1071
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571072int NavigationControllerImpl::GetCurrentEntryIndex() {
[email protected]765b35502008-08-21 00:51:201073 if (pending_entry_index_ != -1)
1074 return pending_entry_index_;
1075 return last_committed_entry_index_;
1076}
1077
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571078NavigationEntryImpl* NavigationControllerImpl::GetLastCommittedEntry() {
Rakina Zata Amni46087a12022-11-11 08:28:381079 CHECK_NE(last_committed_entry_index_, -1);
avif16f85a72015-11-13 18:25:031080 return entries_[last_committed_entry_index_].get();
[email protected]765b35502008-08-21 00:51:201081}
1082
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571083bool NavigationControllerImpl::CanViewSource() {
Takashi Toyoshima6c58bbd2023-05-19 09:41:351084 const std::string& mime_type = frame_tree_->root()
1085 ->current_frame_host()
1086 ->GetPage()
1087 .GetContentsMimeType();
Kinuko Yasuda74702f92017-07-31 03:27:531088 bool is_viewable_mime_type = blink::IsSupportedNonImageMimeType(mime_type) &&
1089 !media::IsSupportedMediaMimeType(mime_type);
[email protected]6286a3792013-10-09 04:03:271090 NavigationEntry* visible_entry = GetVisibleEntry();
1091 return visible_entry && !visible_entry->IsViewSourceMode() &&
Carlos ILd51e7702020-05-07 18:51:391092 is_viewable_mime_type;
[email protected]31682282010-01-15 18:05:161093}
1094
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571095int NavigationControllerImpl::GetLastCommittedEntryIndex() {
arthursonzogni5c4c202d2017-04-25 23:41:271096 // The last committed entry index must always be less than the number of
Rakina Zata Amnie2d31312022-11-18 03:38:451097 // entries.
arthursonzogni5c4c202d2017-04-25 23:41:271098 DCHECK_LT(last_committed_entry_index_, GetEntryCount());
[email protected]a26023822011-12-29 00:23:551099 return last_committed_entry_index_;
1100}
1101
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571102int NavigationControllerImpl::GetEntryCount() {
Rakina Zata Amnie2d31312022-11-18 03:38:451103 DCHECK_GE(entries_.size(), 1u);
Carlos IL4dea8902020-05-26 15:14:291104 DCHECK_LE(entries_.size(), max_entry_count());
[email protected]a26023822011-12-29 00:23:551105 return static_cast<int>(entries_.size());
1106}
1107
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571108NavigationEntryImpl* NavigationControllerImpl::GetEntryAtIndex(int index) {
avi25764702015-06-23 15:43:371109 if (index < 0 || index >= GetEntryCount())
1110 return nullptr;
1111
avif16f85a72015-11-13 18:25:031112 return entries_[index].get();
[email protected]022af742011-12-28 18:37:251113}
1114
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571115NavigationEntryImpl* NavigationControllerImpl::GetEntryAtOffset(int offset) {
avi057ce1492015-06-29 15:59:471116 return GetEntryAtIndex(GetIndexForOffset(offset));
[email protected]765b35502008-08-21 00:51:201117}
1118
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571119int NavigationControllerImpl::GetIndexForOffset(int offset) {
[email protected]7bc2b032012-12-19 22:45:461120 return GetCurrentEntryIndex() + offset;
[email protected]9ba14052012-06-22 23:50:031121}
1122
Arthur Sonzognic686e8f2024-01-11 08:36:371123std::optional<int> NavigationControllerImpl::GetIndexForGoBack() {
Shivani Sharma298d12852019-01-22 20:04:031124 for (int index = GetIndexForOffset(-1); index >= 0; index--) {
Kevin McNee3b3a56192023-03-17 14:40:591125 if (!GetEntryAtIndex(index)->should_skip_on_back_forward_ui()) {
1126 return index;
1127 }
Shivani Sharma298d12852019-01-22 20:04:031128 }
Arthur Sonzognic686e8f2024-01-11 08:36:371129 return std::nullopt;
Kevin McNee3b3a56192023-03-17 14:40:591130}
1131
1132bool NavigationControllerImpl::CanGoBack() {
1133 return GetIndexForGoBack().has_value();
1134}
1135
Arthur Sonzognic686e8f2024-01-11 08:36:371136std::optional<int> NavigationControllerImpl::GetIndexForGoForward() {
Kevin McNee3b3a56192023-03-17 14:40:591137 for (int index = GetIndexForOffset(1); index < GetEntryCount(); index++) {
1138 if (!GetEntryAtIndex(index)->should_skip_on_back_forward_ui()) {
1139 return index;
1140 }
1141 }
Arthur Sonzognic686e8f2024-01-11 08:36:371142 return std::nullopt;
[email protected]765b35502008-08-21 00:51:201143}
1144
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571145bool NavigationControllerImpl::CanGoForward() {
Kevin McNee3b3a56192023-03-17 14:40:591146 return GetIndexForGoForward().has_value();
[email protected]765b35502008-08-21 00:51:201147}
1148
Lucas Furukawa Gadani5553a1582019-01-08 18:55:571149bool NavigationControllerImpl::CanGoToOffset(int offset) {
[email protected]9ba14052012-06-22 23:50:031150 int index = GetIndexForOffset(offset);
1151 return index >= 0 && index < GetEntryCount();
1152}
1153
Xiaohan Wang7f8052e02022-01-14 18:44:281154#if BUILDFLAG(IS_ANDROID)
WangHui74286d52021-03-31 16:17:151155bool NavigationControllerImpl::CanGoToOffsetWithSkipping(int offset) {
WangHui74286d52021-03-31 16:17:151156 if (offset == 0)
1157 return true;
1158 int increment = offset > 0 ? 1 : -1;
1159 int non_skippable_entries = 0;
1160 for (int index = GetIndexForOffset(increment);
1161 index >= 0 && index < GetEntryCount(); index += increment) {
1162 if (!GetEntryAtIndex(index)->should_skip_on_back_forward_ui())
1163 non_skippable_entries++;
1164
1165 if (non_skippable_entries == std::abs(offset))
1166 return true;
1167 }
1168 return false;
1169}
1170#endif
1171
[email protected]d202a7c2012-01-04 07:53:471172void NavigationControllerImpl::GoBack() {
Arthur Sonzognic686e8f2024-01-11 08:36:371173 const std::optional<int> target_index = GetIndexForGoBack();
shivanisha55201872018-12-13 04:29:061174
Kevin McNeeedc481c2023-04-27 22:30:581175 CHECK(target_index.has_value());
Miyoung Shin1c565c912021-03-17 12:11:211176
Kevin McNee3b3a56192023-03-17 14:40:591177 GoToIndex(*target_index);
[email protected]765b35502008-08-21 00:51:201178}
1179
[email protected]d202a7c2012-01-04 07:53:471180void NavigationControllerImpl::GoForward() {
Shivani Sharma2d5b4b6b2019-01-08 16:07:161181 // Note that at least one entry (the last one) will be non-skippable since
1182 // entries are marked skippable only when they add another entry because of
1183 // redirect or pushState.
Arthur Sonzognic686e8f2024-01-11 08:36:371184 const std::optional<int> target_index = GetIndexForGoForward();
Kevin McNee3b3a56192023-03-17 14:40:591185
Kevin McNeeedc481c2023-04-27 22:30:581186 CHECK(target_index.has_value());
Kevin McNee3b3a56192023-03-17 14:40:591187
1188 GoToIndex(*target_index);
[email protected]765b35502008-08-21 00:51:201189}
1190
[email protected]d202a7c2012-01-04 07:53:471191void NavigationControllerImpl::GoToIndex(int index) {
Yoav Weiss8c573952022-11-17 17:35:131192 GoToIndex(index, /*initiator_rfh=*/nullptr,
Arthur Sonzognic686e8f2024-01-11 08:36:371193 /*soft_navigation_heuristics_task_id=*/std::nullopt,
Yoav Weiss8c573952022-11-17 17:35:131194 /*navigation_api_key=*/nullptr);
Dave Tapuska8bfd84c2019-03-26 20:47:161195}
1196
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:261197base::WeakPtr<NavigationRequest> NavigationControllerImpl::GoToIndex(
Nate Chapinbf682fa32022-09-26 22:41:201198 int index,
1199 RenderFrameHostImpl* initiator_rfh,
Arthur Sonzognic686e8f2024-01-11 08:36:371200 std::optional<blink::scheduler::TaskAttributionId>
Yoav Weiss8c573952022-11-17 17:35:131201 soft_navigation_heuristics_task_id,
Nate Chapinbf682fa32022-09-26 22:41:201202 const std::string* navigation_api_key) {
sunjian30574a62017-03-21 21:39:441203 TRACE_EVENT0("browser,navigation,benchmark",
1204 "NavigationControllerImpl::GoToIndex");
Peter Boströmf68fe042023-06-07 18:27:501205 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy_caller1", "GoToIndex_index", index);
1206 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy_caller1", "GoToIndex_size",
1207 entries_.size());
1208 // Indices should have have been validated by the caller.
1209 CHECK_GE(index, 0);
1210 CHECK_LT(static_cast<size_t>(index), entries_.size());
[email protected]765b35502008-08-21 00:51:201211
Rakina Zata Amnif297a802022-01-18 03:53:431212 if (entries_[index]->IsInitialEntryNotForSynchronousAboutBlank()) {
1213 // We should never navigate to an existing initial NavigationEntry that is
1214 // the initial NavigationEntry for the initial empty document that hasn't
1215 // been overridden by the synchronous about:blank commit, to preserve
1216 // legacy behavior where trying to reload when the main frame is on the
1217 // initial empty document won't result in a navigation. See also
1218 // https://crbug.com/1277414.
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:261219 return nullptr;
Rakina Zata Amnif297a802022-01-18 03:53:431220 }
1221
[email protected]cbab76d2008-10-13 22:42:471222 DiscardNonCommittedEntries();
[email protected]765b35502008-08-21 00:51:201223
arthursonzogni5c4c202d2017-04-25 23:41:271224 DCHECK_EQ(nullptr, pending_entry_);
1225 DCHECK_EQ(-1, pending_entry_index_);
Rakina Zata Amnif297a802022-01-18 03:53:431226
arthursonzogni5c4c202d2017-04-25 23:41:271227 pending_entry_ = entries_[index].get();
[email protected]765b35502008-08-21 00:51:201228 pending_entry_index_ = index;
arthursonzogni5c4c202d2017-04-25 23:41:271229 pending_entry_->SetTransitionType(ui::PageTransitionFromInt(
1230 pending_entry_->GetTransitionType() | ui::PAGE_TRANSITION_FORWARD_BACK));
William Liuec04e382024-05-23 18:03:271231 return NavigateToExistingPendingEntry(ReloadType::NONE, initiator_rfh,
1232 soft_navigation_heuristics_task_id,
1233 navigation_api_key);
[email protected]765b35502008-08-21 00:51:201234}
1235
[email protected]d202a7c2012-01-04 07:53:471236void NavigationControllerImpl::GoToOffset(int offset) {
toyoshim3af4d502016-03-30 12:38:121237 // Note: This is actually reached in unit tests.
[email protected]9ba14052012-06-22 23:50:031238 if (!CanGoToOffset(offset))
[email protected]765b35502008-08-21 00:51:201239 return;
1240
[email protected]9ba14052012-06-22 23:50:031241 GoToIndex(GetIndexForOffset(offset));
[email protected]765b35502008-08-21 00:51:201242}
1243
Nate Chapinbf682fa32022-09-26 22:41:201244void NavigationControllerImpl::GoToOffsetFromRenderer(
1245 int offset,
Yoav Weiss8c573952022-11-17 17:35:131246 RenderFrameHostImpl* initiator_rfh,
Arthur Sonzognic686e8f2024-01-11 08:36:371247 std::optional<blink::scheduler::TaskAttributionId>
Yoav Weiss8c573952022-11-17 17:35:131248 soft_navigation_heuristics_task_id) {
Nate Chapinbb74c5a52023-07-21 23:13:351249 // Note: This is actually reached in unit tests.
1250 if (!CanGoToOffset(offset))
Nate Chapin45f620582021-09-30 17:45:431251 return;
1252
Nate Chapinbf682fa32022-09-26 22:41:201253 GoToIndex(GetIndexForOffset(offset), initiator_rfh,
Yoav Weiss8c573952022-11-17 17:35:131254 soft_navigation_heuristics_task_id,
1255 /*navigation_api_key=*/nullptr);
Nate Chapin45f620582021-09-30 17:45:431256}
1257
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:261258base::WeakPtr<NavigationRequest>
1259NavigationControllerImpl::GoToIndexAndReturnPrimaryMainFrameRequest(int index) {
William Liuec04e382024-05-23 18:03:271260 return GoToIndex(index, /*initiator_rfh=*/nullptr,
1261 /*soft_navigation_heuristics_task_id=*/std::nullopt,
1262 /*navigation_api_key=*/nullptr);
1263}
1264
Xiaohan Wang7f8052e02022-01-14 18:44:281265#if BUILDFLAG(IS_ANDROID)
WangHui74286d52021-03-31 16:17:151266void NavigationControllerImpl::GoToOffsetWithSkipping(int offset) {
1267 // Note: This is actually reached in unit tests.
1268 if (!CanGoToOffsetWithSkipping(offset))
1269 return;
1270
Elly Fong-Jonesccc6d1f2021-06-14 18:32:421271 if (offset == 0) {
WangHui74286d52021-03-31 16:17:151272 GoToIndex(GetIndexForOffset(offset));
1273 return;
1274 }
1275 int increment = offset > 0 ? 1 : -1;
1276 // Find the offset without counting skippable entries.
1277 int target_index = GetIndexForOffset(increment);
1278 int non_skippable_entries = 0;
1279 for (int index = target_index; index >= 0 && index < GetEntryCount();
1280 index += increment) {
1281 if (!GetEntryAtIndex(index)->should_skip_on_back_forward_ui())
1282 non_skippable_entries++;
1283
1284 if (non_skippable_entries == std::abs(offset)) {
1285 target_index = index;
1286 break;
1287 }
1288 }
1289
1290 GoToIndex(target_index);
1291}
1292#endif
1293
[email protected]41374f12013-07-24 02:49:281294bool NavigationControllerImpl::RemoveEntryAtIndex(int index) {
Aran Gilman37d11632019-10-08 23:07:151295 if (index == last_committed_entry_index_ || index == pending_entry_index_)
[email protected]41374f12013-07-24 02:49:281296 return false;
[email protected]6a13a6c2011-12-20 21:47:121297
[email protected]43032342011-03-21 14:10:311298 RemoveEntryAtIndexInternal(index);
[email protected]41374f12013-07-24 02:49:281299 return true;
[email protected]cbab76d2008-10-13 22:42:471300}
1301
Michael Thiessen9b14d512019-09-23 21:19:471302void NavigationControllerImpl::PruneForwardEntries() {
1303 DiscardNonCommittedEntries();
1304 int remove_start_index = last_committed_entry_index_ + 1;
Lei Zhang96031532019-10-10 19:05:471305 int num_removed = static_cast<int>(entries_.size()) - remove_start_index;
Michael Thiessen9b14d512019-09-23 21:19:471306 if (num_removed <= 0)
1307 return;
Nate Chapin9eb16be72022-09-23 22:54:311308 RemovedEntriesTracker tracker(weak_factory_.GetSafeRef());
Michael Thiessen9b14d512019-09-23 21:19:471309 entries_.erase(entries_.begin() + remove_start_index, entries_.end());
1310 NotifyPrunedEntries(this, remove_start_index /* start index */,
1311 num_removed /* count */);
1312}
1313
Aran Gilman37d11632019-10-08 23:07:151314void NavigationControllerImpl::UpdateVirtualURLToURL(NavigationEntryImpl* entry,
1315 const GURL& new_url) {
[email protected]38178a42009-12-17 18:58:321316 GURL new_virtual_url(new_url);
[email protected]825b1662012-03-12 19:07:311317 if (BrowserURLHandlerImpl::GetInstance()->ReverseURLRewrite(
[email protected]36fc0392011-12-25 03:59:511318 &new_virtual_url, entry->GetVirtualURL(), browser_context_)) {
1319 entry->SetVirtualURL(new_virtual_url);
[email protected]38178a42009-12-17 18:58:321320 }
1321}
1322
Harkiran Bolariaba823e42021-05-21 18:30:361323base::WeakPtr<NavigationHandle> NavigationControllerImpl::LoadURL(
1324 const GURL& url,
1325 const Referrer& referrer,
1326 ui::PageTransition transition,
1327 const std::string& extra_headers) {
[email protected]cf002332012-08-14 19:17:471328 LoadURLParams params(url);
1329 params.referrer = referrer;
1330 params.transition_type = transition;
1331 params.extra_headers = extra_headers;
Harkiran Bolariaba823e42021-05-21 18:30:361332 return LoadURLWithParams(params);
[email protected]cf002332012-08-14 19:17:471333}
1334
Harkiran Bolariaba823e42021-05-21 18:30:361335base::WeakPtr<NavigationHandle> NavigationControllerImpl::LoadURLWithParams(
1336 const LoadURLParams& params) {
Lukasz Anforowicz435bcb582019-07-12 20:50:061337 if (params.is_renderer_initiated)
1338 DCHECK(params.initiator_origin.has_value());
1339
naskob8744d22014-08-28 17:07:431340 TRACE_EVENT1("browser,navigation",
Aran Gilman37d11632019-10-08 23:07:151341 "NavigationControllerImpl::LoadURLWithParams", "url",
1342 params.url.possibly_invalid_spec());
Ian Vollick9dda0522019-09-11 02:24:291343 bool is_explicit_navigation =
1344 GetContentClient()->browser()->IsExplicitNavigation(
1345 params.transition_type);
1346 if (HandleDebugURL(params.url, params.transition_type,
1347 is_explicit_navigation)) {
[email protected]47752982014-07-29 08:01:431348 // If Telemetry is running, allow the URL load to proceed as if it's
1349 // unhandled, otherwise Telemetry can't tell if Navigation completed.
avi83883c82014-12-23 00:08:491350 if (!base::CommandLine::ForCurrentProcess()->HasSwitch(
[email protected]47752982014-07-29 08:01:431351 cc::switches::kEnableGpuBenchmarking))
Harkiran Bolariaba823e42021-05-21 18:30:361352 return nullptr;
[email protected]47752982014-07-29 08:01:431353 }
[email protected]8bf1048012012-02-08 01:22:181354
[email protected]cf002332012-08-14 19:17:471355 // Checks based on params.load_type.
1356 switch (params.load_type) {
1357 case LOAD_TYPE_DEFAULT:
lukasza477a5a22016-06-16 18:28:431358 case LOAD_TYPE_HTTP_POST:
Shu Yang112ad492024-07-25 17:11:541359#if BUILDFLAG(IS_ANDROID)
1360 case LOAD_TYPE_PDF_ANDROID:
1361#endif
[email protected]cf002332012-08-14 19:17:471362 break;
1363 case LOAD_TYPE_DATA:
[email protected]cca6f392014-05-28 21:32:261364 if (!params.url.SchemeIs(url::kDataScheme)) {
Peter Boström8472105d2024-05-15 04:36:021365 NOTREACHED_IN_MIGRATION() << "Data load must use data scheme.";
Harkiran Bolariaba823e42021-05-21 18:30:361366 return nullptr;
[email protected]cf002332012-08-14 19:17:471367 }
1368 break;
Lukasz Anforowiczbb0cfd5e2017-12-14 22:39:461369 }
[email protected]e47ae9472011-10-13 19:48:341370
[email protected]e47ae9472011-10-13 19:48:341371 // The user initiated a load, we don't need to reload anymore.
1372 needs_reload_ = false;
1373
Harkiran Bolariaba823e42021-05-21 18:30:361374 return NavigateWithoutEntry(params);
[email protected]132e281a2012-07-31 18:32:441375}
1376
Charlie Reis4c53a962023-06-21 23:17:531377void NavigationControllerImpl::LoadOriginalRequestURL() {
1378 // If the original request URL is not valid, matches the current URL, or
1379 // involves POST data, then simply reload. The POST check avoids issues with
1380 // sending data to the wrong page.
1381 const GURL& last_committed_url = GetLastCommittedEntry()->GetURL();
1382 const GURL& original_request_url =
1383 GetLastCommittedEntry()->GetOriginalRequestURL();
1384 if (!original_request_url.is_valid() ||
1385 original_request_url == last_committed_url ||
1386 GetLastCommittedEntry()->GetHasPostData()) {
1387 Reload(ReloadType::NORMAL, true);
1388 return;
1389 }
1390
1391 // Otherwise, attempt to load the original request URL without any of the
1392 // other data from the current NavigationEntry, replacing the current entry.
1393 // Loading the original URL is useful in cases such as modifying the user
1394 // agent.
1395 std::unique_ptr<NavigationController::LoadURLParams> load_params =
1396 std::make_unique<NavigationController::LoadURLParams>(
1397 original_request_url);
1398 load_params->should_replace_current_entry = true;
1399 load_params->transition_type = ui::PAGE_TRANSITION_RELOAD;
1400 LoadURLWithParams(*load_params.get());
1401}
1402
Mohamed Abdelhalim833de902019-09-16 17:41:451403bool NavigationControllerImpl::PendingEntryMatchesRequest(
1404 NavigationRequest* request) const {
creisb4dc9332016-03-14 21:39:191405 return pending_entry_ &&
Mohamed Abdelhalim833de902019-09-16 17:41:451406 pending_entry_->GetUniqueID() == request->nav_entry_id();
creisb4dc9332016-03-14 21:39:191407}
1408
[email protected]d202a7c2012-01-04 07:53:471409bool NavigationControllerImpl::RendererDidNavigate(
creis3da03872015-02-20 21:12:321410 RenderFrameHostImpl* rfh,
arthursonzogni73fe3212020-11-17 13:24:071411 const mojom::DidCommitProvisionalLoadParams& params,
peary21b0f797b2016-09-28 17:28:331412 LoadCommittedDetails* details,
Eugene But712f03d2018-05-22 16:03:441413 bool is_same_document_navigation,
Nate Chapinc7019dd7d2021-06-25 18:29:251414 bool was_on_initial_empty_document,
Shivani Sharmaeef521b2024-01-18 13:03:561415 bool previous_document_had_history_intervention_activation,
Camille Lamy10aafcd32018-12-05 15:48:131416 NavigationRequest* navigation_request) {
1417 DCHECK(navigation_request);
Chris Bookholt27faf8d2022-01-20 01:03:331418
1419 // Note: validation checks and renderer kills due to invalid commit messages
1420 // must happen before getting here, in
1421 // RenderFrameHostImpl::ValidateDidCommitParams. By the time we get here, some
1422 // effects of the navigation have already occurred.
1423
[email protected]cd2e15742013-03-08 04:08:311424 is_initial_navigation_ = false;
1425
Wang Hui96ab1012022-10-11 02:05:491426 // Any pending request to repost a form submission is no longer valid, since a
1427 // different NavigationEntry is committing.
1428 pending_reload_ = ReloadType::NONE;
1429
[email protected]0e8db942008-09-24 21:21:481430 // Save the previous state before we clobber it.
aelias100c9192017-01-13 00:01:431431 bool overriding_user_agent_changed = false;
Rakina Zata Amnie2d31312022-11-18 03:38:451432 if (entry_replaced_by_post_commit_error_) {
1433 // Same document navigation events with a post-commit error should already
1434 // be blocked by RenderFrameHostImpl::ValidateDidCommitParams() before
1435 // reaching here.
1436 CHECK(!is_same_document_navigation);
Chris Bookholt27faf8d2022-01-20 01:03:331437
Xinghui Lub9e86a352024-05-17 16:29:421438 if (pending_entry_) {
1439 // Before `entry_replaced_by_post_commit_error_` is moved back, make sure
1440 // `pending_entry_` isn't pointing to the last committed entry.
1441 // Instead, all reload approaches (e.g., in `Reload` and
1442 // `LoadIfNecessary`) should attempt to load the
1443 // `entry_replaced_by_post_commit_error_` instead of the post commit error
1444 // entry itself.
1445 CHECK_NE(pending_entry_, entries_[last_committed_entry_index_].get())
1446 << "Incorrectly reloading the post commit error page entry.";
1447 }
Xinghui Lue4e50be2024-05-15 21:46:001448
Rakina Zata Amnie2d31312022-11-18 03:38:451449 // Any commit while a post-commit error page is showing should put the
1450 // original entry back, replacing the error page's entry. This includes
1451 // reloads, where the original entry was used as the pending entry and
1452 // should now be at the correct index at commit time.
1453 entries_[last_committed_entry_index_] =
1454 std::move(entry_replaced_by_post_commit_error_);
[email protected]0e8db942008-09-24 21:21:481455 }
Rakina Zata Amnie2d31312022-11-18 03:38:451456 details->previous_main_frame_url = GetLastCommittedEntry()->GetURL();
1457 details->previous_entry_index = GetLastCommittedEntryIndex();
Shu Yang7a3ec532023-06-21 17:49:001458 // Must honor user agent overrides in the |navigation_request|, such as
1459 // from things like RequestDesktopSiteWebContentsObserverAndroid. As a
1460 // result, besides comparing |pending_entry_|'s user agent against
1461 // LastCommittedEntry's, also need to compare |navigation_request|'s user
1462 // agent against LastCommittedEntry's.
1463 if (navigation_request->is_overriding_user_agent() !=
Shu Yang127e41a2023-12-19 01:26:541464 GetLastCommittedEntry()->GetIsOverridingUserAgent() ||
1465 (PendingEntryMatchesRequest(navigation_request) &&
1466 pending_entry_->GetIsOverridingUserAgent() !=
1467 GetLastCommittedEntry()->GetIsOverridingUserAgent())) {
Shu Yang7a3ec532023-06-21 17:49:001468 overriding_user_agent_changed = true;
Rakina Zata Amnie2d31312022-11-18 03:38:451469 }
[email protected]ecd9d8702008-08-28 22:10:171470
Dave Tapuskaa2ab4f252021-07-08 21:31:281471 bool is_main_frame_navigation = !rfh->GetParent();
1472
Alexander Timind2f2e4f22019-04-02 20:04:531473 // TODO(altimin, crbug.com/933147): Remove this logic after we are done with
1474 // implementing back-forward cache.
Dave Tapuskaa2ab4f252021-07-08 21:31:281475 // For primary frame tree navigations, choose an appropriate
Rakina Zata Amni63b5e8092022-05-20 11:25:141476 // BackForwardCacheMetrics to be associated with the new navigation's
1477 // NavigationEntry, by either creating a new object or reusing the previous
1478 // entry's one.
Dave Tapuskaa2ab4f252021-07-08 21:31:281479 scoped_refptr<BackForwardCacheMetrics> back_forward_cache_metrics;
Takashi Toyoshima7c041d82023-09-26 16:09:211480 if (navigation_request->frame_tree_node()->frame_tree().is_primary()) {
Rakina Zata Amni63b5e8092022-05-20 11:25:141481 back_forward_cache_metrics = BackForwardCacheMetrics::
1482 CreateOrReuseBackForwardCacheMetricsForNavigation(
Dave Tapuskaa2ab4f252021-07-08 21:31:281483 GetLastCommittedEntry(), is_main_frame_navigation,
1484 params.document_sequence_number);
1485 }
Yuzu Saijo29f96ca92022-12-08 04:54:121486
Alexander Timind2f2e4f22019-04-02 20:04:531487 // Notify the last active entry that we have navigated away.
Dave Tapuskaa2ab4f252021-07-08 21:31:281488 if (is_main_frame_navigation && !is_same_document_navigation) {
Rakina Zata Amnie2d31312022-11-18 03:38:451489 if (auto* metrics = GetLastCommittedEntry()->back_forward_cache_metrics()) {
1490 metrics->MainFrameDidNavigateAwayFromDocument();
Alexander Timind2f2e4f22019-04-02 20:04:531491 }
1492 }
1493
Rakina Zata Amnifd8370b2022-11-14 13:32:251494 // Use CommonNavigationParam's `should_replace_current_entry` to determine
1495 // whether the current NavigationEntry should be replaced.
Charlie Reisf8cde712022-10-20 16:25:091496 // (See below for a case where we might override that.)
Rakina Zata Amnifd8370b2022-11-14 13:32:251497 details->did_replace_entry =
1498 navigation_request->common_params().should_replace_current_entry;
Charlie Reisf8cde712022-10-20 16:25:091499
fdegans9caf66a2015-07-30 21:10:421500 // If there is a pending entry at this point, it should have a SiteInstance,
Charlie Reisc4155af2022-10-19 15:33:111501 // except for restored entries. This should be true even if the current commit
1502 // is not related to the pending entry.
jam48cea9082017-02-15 06:13:291503 bool was_restored = false;
toyoshim0df1d3a2016-09-09 09:52:481504 DCHECK(pending_entry_index_ == -1 || pending_entry_->site_instance() ||
Lukasz Anforowicz6b75c0d2020-12-01 22:56:081505 pending_entry_->IsRestored());
Charlie Reisc4155af2022-10-19 15:33:111506
1507 // Only make changes based on the pending entry if the NavigationRequest
1508 // matches it. Otherwise, the pending entry may be for a different request
1509 // (e.g., if a slow history navigation is pending while an auto-subframe
1510 // commit occurs).
1511 if (PendingEntryMatchesRequest(navigation_request)) {
1512 // It is no longer necessary to consider the pending entry as restored.
1513 if (pending_entry_->IsRestored()) {
1514 pending_entry_->set_restore_type(RestoreType::kNotRestored);
1515 was_restored = true;
1516 }
[email protected]e9ba4472008-09-14 15:42:431517
Charlie Reisf8cde712022-10-20 16:25:091518 // If the SiteInstance has changed from the matching pending entry, this
1519 // must be treated as a new navigation with replacement. Set the replacement
1520 // bit here and ClassifyNavigation will identify this case and return
1521 // NEW_ENTRY.
1522 if (!rfh->GetParent() && pending_entry_->site_instance() &&
1523 pending_entry_->site_instance() != rfh->GetSiteInstance()) {
1524 DCHECK_NE(-1, pending_entry_index_);
Rakina Zata Amnifd8370b2022-11-14 13:32:251525 // TODO(nasko,creis,rakina): Move this to happen before committing the
1526 // navigation. This is a bit complicated because we don't currently
1527 // set `should_replace_current_entry` for reload/history navigations.
Charlie Reisf8cde712022-10-20 16:25:091528 details->did_replace_entry = true;
1529 }
Nasko Oskovaee2f862018-06-15 00:05:521530 }
[email protected]bcd904482012-02-01 01:54:221531
[email protected]e9ba4472008-09-14 15:42:431532 // Do navigation-type specific actions. These will make and commit an entry.
Miyoung Shin3299cbf2022-11-22 01:41:101533 NavigationType navigation_type =
1534 ClassifyNavigation(rfh, params, navigation_request);
1535 navigation_request->set_navigation_type(navigation_type);
shivanigithub189833f2022-04-27 18:08:451536
Rakina Zata Amnie2d31312022-11-18 03:38:451537 if (ShouldMaintainTrivialSessionHistory(rfh->frame_tree_node())) {
shivanigithub189833f2022-04-27 18:08:451538 // Ensure that this navigation does not add a navigation entry, since
1539 // ShouldMaintainTrivialSessionHistory() means we should not add an entry
1540 // beyond the last committed one. Therefore, `should_replace_current_entry`
1541 // should be set, which replaces the current entry, or this should be a
1542 // reload, which does not create a new entry.
Rakina Zata Amnifd8370b2022-11-14 13:32:251543 DCHECK(navigation_request->common_params().should_replace_current_entry ||
Dominic Farolinoe0f8d7c2023-08-16 15:38:331544 navigation_request->GetReloadType() != ReloadType::NONE);
shivanigithub189833f2022-04-27 18:08:451545 }
1546
Rakina Zata Amnie2d31312022-11-18 03:38:451547 if (GetLastCommittedEntry()->IsInitialEntry()) {
Rakina Zata Amniddf10502022-01-15 02:56:551548 if (rfh->GetParent()) {
Rakina Zata Amni2322f4f82022-01-24 13:24:241549 // This is a subframe navigation on the initial empty document, which used
1550 // to not have a NavigationEntry to attach to. Now it can attach to the
1551 // initial NavigationEntry, and we must ensure that its NavigationEntry
1552 // will keep the "initial NavigationEntry" status and won't append a new
1553 // NavigationEntry (it should always do replacement instead).
1554 // See also https://crbug.com/1277414.
1555 details->should_stay_as_initial_entry = true;
Rakina Zata Amniddf10502022-01-15 02:56:551556 // Subframe navigation on initial NavigationEntry must not append a new
1557 // NavigationEntry (i.e. should not be classified as NEW_SUBFRAME). This
1558 // means every subframe navigation that happens while we're on the initial
1559 // NavigationEntry will always reuse the existing NavigationEntry and
1560 // just update the corresponding FrameNavigationEntry.
Miyoung Shin3299cbf2022-11-22 01:41:101561 DCHECK_EQ(navigation_type, NAVIGATION_TYPE_AUTO_SUBFRAME);
1562 } else if (navigation_type == NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY) {
Rakina Zata Amniddf10502022-01-15 02:56:551563 // This is a navigation that modifies the initial NavigationEntry, either
1564 // for a replacement or a reload. The initial NavigationEntry should
1565 // retain its "initial NavigationEntry" status in this case.
1566 details->should_stay_as_initial_entry = true;
Rakina Zata Amni2322f4f82022-01-24 13:24:241567 } else if (navigation_request->is_synchronous_renderer_commit() &&
Rakina Zata Amnifd8370b2022-11-14 13:32:251568 !navigation_request->IsSameDocument() && !rfh->GetParent()) {
1569 DCHECK(navigation_request->common_params().should_replace_current_entry);
Rakina Zata Amni2322f4f82022-01-24 13:24:241570 // This is a synchronous about:blank navigation on the main frame, which
1571 // used to not create a NavigationEntry when we have no NavigationEntry on
1572 // FrameTree creation. We now have the initial NavigationEntry and are on
1573 // the initial NavigationEntry. To preserve old behavior, we should still
1574 // keep the "initial" status for the new NavigationEntry that we will
1575 // create for this navigation, so that subframe navigations under the
1576 // synchronously committed about:blank document will never append new
1577 // NavigationEntry, and instead will just reuse the initial
1578 // NavigationEntry and modify the corresponding FrameNavigationEntries.
1579 // See also https://crbug.com/1277414.
1580 details->should_stay_as_initial_entry = true;
Rakina Zata Amniddf10502022-01-15 02:56:551581 }
1582 }
1583 DCHECK(!details->should_stay_as_initial_entry ||
1584 GetLastCommittedEntry()->IsInitialEntry());
[email protected]4bf3522c2010-08-19 21:00:201585
eugenebutee08663a2017-04-27 17:43:121586 // is_same_document must be computed before the entry gets committed.
Eugene But712f03d2018-05-22 16:03:441587 details->is_same_document = is_same_document_navigation;
[email protected]b9d4dfdc2013-08-08 00:25:121588
Lucas Furukawa Gadanie3f7e792021-04-22 17:56:071589 details->is_prerender_activation =
1590 navigation_request->IsPrerenderedPageActivation();
Robert Lin540dbd12022-04-28 22:07:241591 details->is_in_active_page = navigation_request->GetRenderFrameHost()
1592 ->GetOutermostMainFrame()
1593 ->IsInPrimaryMainFrame();
Lucas Furukawa Gadanie3f7e792021-04-22 17:56:071594
Peter Boströmd7592132019-01-30 04:50:311595 // Make sure we do not discard the pending entry for a different ongoing
1596 // navigation when a same document commit comes in unexpectedly from the
1597 // renderer. Limit this to a very narrow set of conditions to avoid risks to
1598 // other navigation types. See https://crbug.com/900036.
Alison Gale770f3fc2024-04-27 00:39:581599 // TODO(crbug.com/41437754): Handle history.pushState() as well.
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061600 bool keep_pending_entry =
1601 is_same_document_navigation &&
Miyoung Shin3299cbf2022-11-22 01:41:101602 navigation_type == NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY &&
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061603 pending_entry_ && !PendingEntryMatchesRequest(navigation_request);
Peter Boströmd7592132019-01-30 04:50:311604
Miyoung Shin3299cbf2022-11-22 01:41:101605 switch (navigation_type) {
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061606 case NAVIGATION_TYPE_MAIN_FRAME_NEW_ENTRY:
Charlie Reisc0f17d2d2021-01-12 18:52:491607 RendererDidNavigateToNewEntry(
shivanisha41f04c52018-12-12 15:52:051608 rfh, params, details->is_same_document, details->did_replace_entry,
Shivani Sharmaeef521b2024-01-18 13:03:561609 previous_document_had_history_intervention_activation,
1610 navigation_request, details);
[email protected]e9ba4472008-09-14 15:42:431611 break;
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061612 case NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY:
Charlie Reisc0f17d2d2021-01-12 18:52:491613 RendererDidNavigateToExistingEntry(rfh, params, details->is_same_document,
1614 was_restored, navigation_request,
Rakina Zata Amnia4e27222021-12-22 01:05:001615 keep_pending_entry, details);
[email protected]e9ba4472008-09-14 15:42:431616 break;
[email protected]8ff00d72012-10-23 19:12:211617 case NAVIGATION_TYPE_NEW_SUBFRAME:
Shivani Sharmaffb32b82019-04-09 16:58:471618 RendererDidNavigateNewSubframe(
1619 rfh, params, details->is_same_document, details->did_replace_entry,
Shivani Sharmaeef521b2024-01-18 13:03:561620 previous_document_had_history_intervention_activation,
1621 navigation_request, details);
[email protected]e9ba4472008-09-14 15:42:431622 break;
[email protected]8ff00d72012-10-23 19:12:211623 case NAVIGATION_TYPE_AUTO_SUBFRAME:
Antonio Sartori78a749f2020-11-30 12:03:391624 if (!RendererDidNavigateAutoSubframe(
Nate Chapinc7019dd7d2021-06-25 18:29:251625 rfh, params, details->is_same_document,
Rakina Zata Amnia4e27222021-12-22 01:05:001626 was_on_initial_empty_document, navigation_request, details)) {
creisce0ef3572017-01-26 17:53:081627 // We don't send a notification about auto-subframe PageState during
1628 // UpdateStateForFrame, since it looks like nothing has changed. Send
1629 // it here at commit time instead.
1630 NotifyEntryChanged(GetLastCommittedEntry());
[email protected]e9ba4472008-09-14 15:42:431631 return false;
creis59d5a47cb2016-08-24 23:57:191632 }
[email protected]e9ba4472008-09-14 15:42:431633 break;
Aran Gilman37d11632019-10-08 23:07:151634 case NAVIGATION_TYPE_UNKNOWN:
Peter Boström8472105d2024-05-15 04:36:021635 NOTREACHED_IN_MIGRATION();
Aran Gilman37d11632019-10-08 23:07:151636 break;
[email protected]765b35502008-08-21 00:51:201637 }
1638
[email protected]688aa65c62012-09-28 04:32:221639 // At this point, we know that the navigation has just completed, so
1640 // record the time.
1641 //
1642 // TODO(akalin): Use "sane time" as described in
Adam Langley4463fb832018-01-28 22:42:261643 // https://www.chromium.org/developers/design-documents/sane-time .
[email protected]c5b88d82012-10-06 17:03:331644 base::Time timestamp =
1645 time_smoother_.GetSmoothedTime(get_timestamp_callback_.Run());
1646 DVLOG(1) << "Navigation finished at (smoothed) timestamp "
danakjf26536bf2020-09-10 00:46:131647 << timestamp.ToDeltaSinceWindowsEpoch().InMicroseconds();
[email protected]688aa65c62012-09-28 04:32:221648
Peter Boströmd7592132019-01-30 04:50:311649 // If we aren't keeping the pending entry, there shouldn't be one at this
1650 // point. Clear it again in case any error cases above forgot to do so.
1651 // TODO(pbos): Consider a CHECK here that verifies that the pending entry has
1652 // been cleared instead of protecting against it.
1653 if (!keep_pending_entry)
Rakina Zata Amniddf10502022-01-15 02:56:551654 DiscardNonCommittedEntriesWithCommitDetails(details);
[email protected]f233e4232013-02-23 00:55:141655
[email protected]e9ba4472008-09-14 15:42:431656 // All committed entries should have nonempty content state so WebKit doesn't
1657 // get confused when we go back to them (see the function for details).
creis0cade2e2017-02-28 06:37:471658 DCHECK(params.page_state.IsValid()) << "Shouldn't see an empty PageState.";
creis3da03872015-02-20 21:12:321659 NavigationEntryImpl* active_entry = GetLastCommittedEntry();
[email protected]688aa65c62012-09-28 04:32:221660 active_entry->SetTimestamp(timestamp);
[email protected]f49737b32013-08-28 07:51:441661 active_entry->SetHttpStatusCode(params.http_status_code);
Fergal Daly0686c0e2022-06-28 02:08:141662
Alexander Timind2f2e4f22019-04-02 20:04:531663 // TODO(altimin, crbug.com/933147): Remove this logic after we are done with
1664 // implementing back-forward cache.
Dave Tapuskaa2ab4f252021-07-08 21:31:281665 if (back_forward_cache_metrics &&
1666 !active_entry->back_forward_cache_metrics()) {
Alexander Timind2f2e4f22019-04-02 20:04:531667 active_entry->set_back_forward_cache_metrics(
1668 std::move(back_forward_cache_metrics));
1669 }
Dave Tapuskaa2ab4f252021-07-08 21:31:281670
1671 // `back_forward_cache_metrics()` may return null as we do not record
1672 // back-forward cache metrics for navigations in non-primary frame trees.
1673 if (active_entry->back_forward_cache_metrics()) {
Alison Gale770f3fc2024-04-27 00:39:581674 // TODO(crbug.com/40229455): Remove this.
Fergal Daly0686c0e2022-06-28 02:08:141675 // These are both only available from details at this point, so we capture
1676 // them here.
1677 SCOPED_CRASH_KEY_NUMBER("BFCacheMismatch", "navigation_type",
Miyoung Shin3299cbf2022-11-22 01:41:101678 navigation_type);
Fergal Daly0686c0e2022-06-28 02:08:141679 SCOPED_CRASH_KEY_BOOL("BFCacheMismatch", "did_replace",
1680 details->did_replace_entry);
Dave Tapuskaa2ab4f252021-07-08 21:31:281681 active_entry->back_forward_cache_metrics()->DidCommitNavigation(
1682 navigation_request,
Rakina Zata Amni84a859df2024-06-07 15:56:321683 IsBackForwardCacheEnabled() &&
1684 rfh->delegate()->IsBackForwardCacheSupported() &&
1685 back_forward_cache_.IsAllowed(navigation_request->GetURL()));
Dave Tapuskaa2ab4f252021-07-08 21:31:281686 }
naskoc7533512016-05-06 17:01:121687
Charles Reisc0507202017-09-21 00:40:021688 // Grab the corresponding FrameNavigationEntry for a few updates, but only if
1689 // the SiteInstance matches (to avoid updating the wrong entry by mistake).
1690 // A mismatch can occur if the renderer lies or due to a unique name collision
1691 // after a race with an OOPIF (see https://crbug.com/616820).
naskoc7533512016-05-06 17:01:121692 FrameNavigationEntry* frame_entry =
1693 active_entry->GetFrameEntry(rfh->frame_tree_node());
Charles Reisc0507202017-09-21 00:40:021694 if (frame_entry && frame_entry->site_instance() != rfh->GetSiteInstance())
1695 frame_entry = nullptr;
Charles Reisf44482022017-10-13 21:15:031696 // Make sure we've updated the PageState in one of the helper methods.
creisce0ef3572017-01-26 17:53:081697 // TODO(creis): Remove the "if" once https://crbug.com/522193 is fixed.
1698 if (frame_entry) {
Charles Reisf44482022017-10-13 21:15:031699 DCHECK(params.page_state == frame_entry->page_state());
Nasko Oskovbbcfc0002019-11-20 20:03:201700
1701 // Remember the bindings the renderer process has at this point, so that
1702 // we do not grant this entry additional bindings if we come back to it.
1703 frame_entry->SetBindings(rfh->GetEnabledBindings());
creis4e2ecb72015-06-20 00:46:301704 }
[email protected]132e281a2012-07-31 18:32:441705
[email protected]97d8f0d2013-10-29 16:49:211706 // Once it is committed, we no longer need to track several pieces of state on
1707 // the entry.
naskoc7533512016-05-06 17:01:121708 active_entry->ResetForCommit(frame_entry);
[email protected]60d6cca2013-04-30 08:47:131709
[email protected]49bd30e62011-03-22 20:12:591710 // The active entry's SiteInstance should match our SiteInstance.
[email protected]a1b99262013-12-27 21:56:221711 // TODO(creis): This check won't pass for subframes until we create entries
1712 // for subframe navigations.
avi39c1edd32015-06-04 20:06:001713 if (!rfh->GetParent())
creis77c9aa32015-09-25 19:59:421714 CHECK_EQ(active_entry->site_instance(), rfh->GetSiteInstance());
[email protected]49bd30e62011-03-22 20:12:591715
[email protected]e9ba4472008-09-14 15:42:431716 // Now prep the rest of the details for the notification and broadcast.
[email protected]0f38dc4552011-02-25 11:24:001717 details->entry = active_entry;
avi39c1edd32015-06-04 20:06:001718 details->is_main_frame = !rfh->GetParent();
[email protected]2e39d2e2009-02-19 18:41:311719 details->http_status_code = params.http_status_code;
estarka5635c42015-07-14 00:06:531720
arthursonzogni7ddc6542021-04-09 09:16:501721 active_entry->SetIsOverridingUserAgent(
1722 navigation_request->is_overriding_user_agent());
Scott Violetc36f7462020-05-06 23:13:031723
[email protected]93f230e02011-06-01 14:40:001724 NotifyNavigationEntryCommitted(details);
initial.commit09911bf2008-07-26 23:55:291725
aelias100c9192017-01-13 00:01:431726 if (overriding_user_agent_changed)
1727 delegate_->UpdateOverridingUserAgent();
1728
creis03b48002015-11-04 00:54:561729 // Update the nav_entry_id for each RenderFrameHost in the tree, so that each
1730 // one knows the latest NavigationEntry it is showing (whether it has
1731 // committed anything in this navigation or not). This allows things like
1732 // state and title updates from RenderFrames to apply to the latest relevant
1733 // NavigationEntry.
dcheng57e39e22016-01-21 00:25:381734 int nav_entry_id = active_entry->GetUniqueID();
Ali Hijazid87307d2022-11-07 20:15:031735 for (FrameTreeNode* node : frame_tree_->Nodes())
dcheng57e39e22016-01-21 00:25:381736 node->current_frame_host()->set_nav_entry_id(nav_entry_id);
Hayato Ito2c8c08d02021-06-23 03:38:431737
1738 if (navigation_request->IsPrerenderedPageActivation()) {
1739 BroadcastHistoryOffsetAndLength();
Alison Gale47d1537d2024-04-19 21:31:461740 // TODO(crbug.com/40187392): Broadcasting happens after the prerendered page
Hayato Ito2c8c08d02021-06-23 03:38:431741 // is activated. As a result, a "prerenderingchange" event listener sees the
1742 // history.length which is not updated yet. We should guarantee that
1743 // history's length and offset should be updated before a
1744 // "prerenderingchange" event listener runs. One possible approach is to use
1745 // the same IPC which "prerenderingchange" uses, and propagate history's
1746 // length and offset together with that.
1747 }
1748
[email protected]e9ba4472008-09-14 15:42:431749 return true;
initial.commit09911bf2008-07-26 23:55:291750}
1751
[email protected]8ff00d72012-10-23 19:12:211752NavigationType NavigationControllerImpl::ClassifyNavigation(
creis3da03872015-02-20 21:12:321753 RenderFrameHostImpl* rfh,
Rakina Zata Amnif6950d552020-11-24 03:26:101754 const mojom::DidCommitProvisionalLoadParams& params,
Rakina Zata Amni2322f4f82022-01-24 13:24:241755 NavigationRequest* navigation_request) {
Piotr Tworekbad51282020-09-30 19:17:591756 TraceReturnReason<tracing_category::kNavigation> trace_return(
Nasko Oskovae49e292020-08-13 02:08:511757 "ClassifyNavigation");
1758
avi7c6f35e2015-05-08 17:52:381759 if (params.did_create_new_entry) {
Rakina Zata Amni2322f4f82022-01-24 13:24:241760 // A new entry. We may or may not have a corresponding pending entry, and
1761 // this may or may not be the main frame.
avi39c1edd32015-06-04 20:06:001762 if (!rfh->GetParent()) {
Charlie Reisc0f17d2d2021-01-12 18:52:491763 trace_return.set_return_reason("new entry, no parent, new entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061764 return NAVIGATION_TYPE_MAIN_FRAME_NEW_ENTRY;
avi7c6f35e2015-05-08 17:52:381765 }
Rakina Zata Amni2322f4f82022-01-24 13:24:241766 // Valid subframe navigation.
Nasko Oskovae49e292020-08-13 02:08:511767 trace_return.set_return_reason("new entry, new subframe");
avi7c6f35e2015-05-08 17:52:381768 return NAVIGATION_TYPE_NEW_SUBFRAME;
1769 }
1770
Charlie Reisc0f17d2d2021-01-12 18:52:491771 // We only clear the session history in tests when navigating to a new entry.
avi7c6f35e2015-05-08 17:52:381772 DCHECK(!params.history_list_was_cleared);
1773
avi39c1edd32015-06-04 20:06:001774 if (rfh->GetParent()) {
avi7c6f35e2015-05-08 17:52:381775 // All manual subframes would be did_create_new_entry and handled above, so
1776 // we know this is auto.
Rakina Zata Amniacd4df662022-11-15 06:49:081777 trace_return.set_return_reason("subframe, last commmited, auto subframe");
1778 return NAVIGATION_TYPE_AUTO_SUBFRAME;
avi7c6f35e2015-05-08 17:52:381779 }
1780
Rakina Zata Amnif6950d552020-11-24 03:26:101781 const int nav_entry_id = navigation_request->commit_params().nav_entry_id;
1782 if (nav_entry_id == 0) {
avi7c6f35e2015-05-08 17:52:381783 // This is a renderer-initiated navigation (nav_entry_id == 0), but didn't
1784 // create a new page.
1785
Hayato Ito2ae49442021-07-02 02:59:251786 // This main frame navigation is not a history navigation (since
1787 // nav_entry_id is 0), but didn't create a new entry. So this must be a
1788 // reload or a replacement navigation, which will modify the existing entry.
1789 //
Nasko Oskov332593c2018-08-16 17:21:341790 // TODO(nasko): With error page isolation, reloading an existing session
1791 // history entry can result in change of SiteInstance. Check for such a case
Charlie Reisc0f17d2d2021-01-12 18:52:491792 // here and classify it as NEW_ENTRY, as such navigations should be treated
Nasko Oskov332593c2018-08-16 17:21:341793 // as new with replacement.
Nasko Oskovae49e292020-08-13 02:08:511794 trace_return.set_return_reason(
Charlie Reisc0f17d2d2021-01-12 18:52:491795 "nav entry 0, last committed, existing entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061796 return NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY;
avi7c6f35e2015-05-08 17:52:381797 }
1798
Charlie Reisf8cde712022-10-20 16:25:091799 if (PendingEntryMatchesRequest(navigation_request)) {
Nasko Oskovaee2f862018-06-15 00:05:521800 // If the SiteInstance of the |pending_entry_| does not match the
1801 // SiteInstance that got committed, treat this as a new navigation with
1802 // replacement. This can happen if back/forward/reload encounters a server
1803 // redirect to a different site or an isolated error page gets successfully
1804 // reloaded into a different SiteInstance.
1805 if (pending_entry_->site_instance() &&
1806 pending_entry_->site_instance() != rfh->GetSiteInstance()) {
Charlie Reisc0f17d2d2021-01-12 18:52:491807 trace_return.set_return_reason("pending matching nav entry, new entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061808 return NAVIGATION_TYPE_MAIN_FRAME_NEW_ENTRY;
Nasko Oskovaee2f862018-06-15 00:05:521809 }
creis77c9aa32015-09-25 19:59:421810
Nasko Oskovaee2f862018-06-15 00:05:521811 if (pending_entry_index_ == -1) {
1812 // In this case, we have a pending entry for a load of a new URL but Blink
1813 // didn't do a new navigation (params.did_create_new_entry). First check
1814 // to make sure Blink didn't treat a new cross-process navigation as
1815 // inert, and thus set params.did_create_new_entry to false. In that case,
Charlie Reis7e2cb6d2021-01-26 01:27:161816 // we must treat it as NEW rather than the converted reload case below,
1817 // since the new SiteInstance doesn't match the last committed entry.
Rakina Zata Amnie2d31312022-11-18 03:38:451818 if (GetLastCommittedEntry()->site_instance() != rfh->GetSiteInstance()) {
Charlie Reis7e2cb6d2021-01-26 01:27:161819 trace_return.set_return_reason("new pending, new entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061820 return NAVIGATION_TYPE_MAIN_FRAME_NEW_ENTRY;
Nasko Oskovaee2f862018-06-15 00:05:521821 }
1822
1823 // Otherwise, this happens when you press enter in the URL bar to reload.
Charlie Reis7e2cb6d2021-01-26 01:27:161824 // We will create a pending entry, but NavigateWithoutEntry will convert
1825 // it to a reload since it's the same page and not create a new entry for
1826 // it. (The user doesn't want to have a new back/forward entry when they
1827 // do this.) Therefore we want to just ignore the pending entry and go
1828 // back to where we were (the "existing entry").
1829 trace_return.set_return_reason("new pending, existing (same) entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061830 return NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY;
Nasko Oskovaee2f862018-06-15 00:05:521831 }
avi7c6f35e2015-05-08 17:52:381832 }
1833
Rakina Zata Amni153d5702021-09-13 22:48:001834 if (navigation_request->commit_params().intended_as_new_entry) {
avi7c6f35e2015-05-08 17:52:381835 // This was intended to be a navigation to a new entry but the pending entry
Charlie Reisc0f17d2d2021-01-12 18:52:491836 // got cleared in the meanwhile. Classify as EXISTING_ENTRY because we may
1837 // or may not have a pending entry.
Charlie Reis7e2cb6d2021-01-26 01:27:161838 trace_return.set_return_reason("intended as new entry, existing entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061839 return NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY;
avi7c6f35e2015-05-08 17:52:381840 }
1841
Rakina Zata Amni3a1c0ec2021-04-15 03:35:121842 if (navigation_request->DidEncounterError() &&
1843 failed_pending_entry_id_ != 0 &&
Rakina Zata Amnif6950d552020-11-24 03:26:101844 nav_entry_id == failed_pending_entry_id_) {
avi7c6f35e2015-05-08 17:52:381845 // If the renderer was going to a new pending entry that got cleared because
1846 // of an error, this is the case of the user trying to retry a failed load
Charlie Reisc0f17d2d2021-01-12 18:52:491847 // by pressing return. Classify as EXISTING_ENTRY because we probably don't
avi7c6f35e2015-05-08 17:52:381848 // have a pending entry.
Nasko Oskovae49e292020-08-13 02:08:511849 trace_return.set_return_reason(
Charlie Reisc0f17d2d2021-01-12 18:52:491850 "unreachable, matching pending, existing entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061851 return NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY;
avi7c6f35e2015-05-08 17:52:381852 }
1853
Charlie Reisc0f17d2d2021-01-12 18:52:491854 // Now we know that the notification is for an existing entry; find it.
Rakina Zata Amnif6950d552020-11-24 03:26:101855 int existing_entry_index = GetEntryIndexWithUniqueID(nav_entry_id);
Nasko Oskovae49e292020-08-13 02:08:511856 trace_return.traced_value()->SetInteger("existing_entry_index",
1857 existing_entry_index);
avi7c6f35e2015-05-08 17:52:381858 if (existing_entry_index == -1) {
avi5cad4912015-06-19 05:25:441859 // The renderer has committed a navigation to an entry that no longer
1860 // exists. Because the renderer is showing that page, resurrect that entry.
Charlie Reisc0f17d2d2021-01-12 18:52:491861 trace_return.set_return_reason("existing entry -1, new entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061862 return NAVIGATION_TYPE_MAIN_FRAME_NEW_ENTRY;
avi7c6f35e2015-05-08 17:52:381863 }
1864
avi7c6f35e2015-05-08 17:52:381865 // Since we weeded out "new" navigations above, we know this is an existing
1866 // (back/forward) navigation.
Charlie Reisc0f17d2d2021-01-12 18:52:491867 trace_return.set_return_reason("default return, existing entry");
Yoshisato Yanagisawa2ccba602021-11-17 08:24:061868 return NAVIGATION_TYPE_MAIN_FRAME_EXISTING_ENTRY;
avi7c6f35e2015-05-08 17:52:381869}
1870
Rakina Zata Amni3460d382021-10-29 00:43:371871void NavigationControllerImpl::UpdateNavigationEntryDetails(
1872 NavigationEntryImpl* entry,
1873 RenderFrameHostImpl* rfh,
1874 const mojom::DidCommitProvisionalLoadParams& params,
1875 NavigationRequest* request,
1876 NavigationEntryImpl::UpdatePolicy update_policy,
Rakina Zata Amnia4e27222021-12-22 01:05:001877 bool is_new_entry,
1878 LoadCommittedDetails* commit_details) {
Rakina Zata Amni3460d382021-10-29 00:43:371879 // Update the FrameNavigationEntry.
Rakina Zata Amniafd3c6582021-11-30 06:19:171880 std::vector<GURL> redirects;
Rakina Zata Amni3460d382021-10-29 00:43:371881 entry->AddOrUpdateFrameEntry(
1882 rfh->frame_tree_node(), update_policy, params.item_sequence_number,
Domenic Denicolacc094fb2022-03-16 23:40:571883 params.document_sequence_number, params.navigation_api_key,
Rakina Zata Amni3460d382021-10-29 00:43:371884 rfh->GetSiteInstance(), nullptr, params.url,
1885 GetCommittedOriginForFrameEntry(params, request),
Rakina Zata Amniafd3c6582021-11-30 06:19:171886 Referrer(*params.referrer),
1887 request ? request->common_params().initiator_origin : params.origin,
Arthur Sonzognic686e8f2024-01-11 08:36:371888 request ? request->common_params().initiator_base_url : std::nullopt,
Rakina Zata Amniafd3c6582021-11-30 06:19:171889 request ? request->GetRedirectChain() : redirects, params.page_state,
1890 params.method, params.post_id, nullptr /* blob_url_loader_factory */,
Rakina Zata Amni3460d382021-10-29 00:43:371891 ComputePolicyContainerPoliciesForFrameEntry(
Rakina Zata Amniafd3c6582021-11-30 06:19:171892 rfh, request && request->IsSameDocument(),
1893 request ? request->common_params().url : params.url));
Rakina Zata Amni3460d382021-10-29 00:43:371894
1895 if (rfh->GetParent()) {
1896 // Only modify the NavigationEntry for main frame navigations.
1897 return;
1898 }
1899 if (entry->update_virtual_url_with_url())
1900 UpdateVirtualURLToURL(entry, params.url);
1901 // Don't use the page type from the pending entry. Some interstitial page
1902 // may have set the type to interstitial. Once we commit, however, the page
1903 // type must always be normal or error.
Rakina Zata Amniafd3c6582021-11-30 06:19:171904 entry->set_page_type((request && request->DidEncounterError())
1905 ? PAGE_TYPE_ERROR
1906 : PAGE_TYPE_NORMAL);
Rakina Zata Amnif297a802022-01-18 03:53:431907 if (commit_details && commit_details->should_stay_as_initial_entry) {
1908 // Retain the "initial NavigationEntry" status.
1909 if (request->IsSameDocument()) {
1910 // If this is for a same-document navigation, the NavigationEntry must be
1911 // reused and should already be marked as the initial NavigationEntry.
1912 DCHECK(entry->IsInitialEntry());
1913 } else {
1914 // If this is for a cross-document navigation, it can be caused by a
1915 // renderer-initiated reload, or the synchronous about:blank commit. Mark
1916 // "for synchronous about:blank" in the latter case, and also when it is
1917 // reloading a "for synchronous about:blank" entry. Otherwise, the entry
1918 // is not for a synchronous about:blank commit.
1919 NavigationEntryImpl::InitialNavigationEntryState new_state =
1920 NavigationEntryImpl::InitialNavigationEntryState::
1921 kInitialNotForSynchronousAboutBlank;
1922 if (entry->IsInitialEntryForSynchronousAboutBlank() ||
1923 request->is_synchronous_renderer_commit()) {
1924 new_state = NavigationEntryImpl::InitialNavigationEntryState::
1925 kInitialForSynchronousAboutBlank;
1926 }
1927 entry->set_initial_navigation_entry_state(new_state);
1928 }
1929 } else if (commit_details && !commit_details->should_stay_as_initial_entry) {
1930 // Remove the "initial NavigationEntry" status.
1931 entry->set_initial_navigation_entry_state(
1932 NavigationEntryImpl::InitialNavigationEntryState::kNonInitial);
Rakina Zata Amnia4e27222021-12-22 01:05:001933 }
Rakina Zata Amniddf10502022-01-15 02:56:551934
Rakina Zata Amni3460d382021-10-29 00:43:371935 if (is_new_entry) {
1936 // Some properties of the NavigationEntry are only set when the entry is
1937 // new (we aren't reusing it).
1938 entry->SetTransitionType(params.transition);
Rakina Zata Amniafd3c6582021-11-30 06:19:171939 entry->SetOriginalRequestURL(request ? request->GetOriginalRequestURL()
Peter Kasting8104ba82024-01-31 15:23:401940 : GURL());
Adithya Srinivasan72b07352023-12-21 15:56:011941 DCHECK_EQ(rfh->GetPage().is_overriding_user_agent(),
1942 params.is_overriding_user_agent);
Rakina Zata Amni3460d382021-10-29 00:43:371943 entry->SetIsOverridingUserAgent(params.is_overriding_user_agent);
1944 } else {
1945 // We are reusing the NavigationEntry. The site instance will normally be
1946 // the same except for a few cases:
1947 // 1) session restore, when no site instance will be assigned or
1948 // 2) redirect, when the site instance is reset.
1949 DCHECK(!entry->site_instance() || !entry->GetRedirectChain().empty() ||
1950 entry->site_instance() == rfh->GetSiteInstance());
1951 }
1952}
1953
Rakina Zata Amniafd3c6582021-11-30 06:19:171954void NavigationControllerImpl::CreateInitialEntry() {
1955 DCHECK_EQ(entries_.size(), 0u);
Ali Hijazid87307d2022-11-07 20:15:031956 RenderFrameHostImpl* rfh = frame_tree_->root()->current_frame_host();
Rakina Zata Amniafd3c6582021-11-30 06:19:171957 auto params = mojom::DidCommitProvisionalLoadParams::New();
1958 // The initial NavigationEntry's URL is the empty URL. This preserves the old
1959 // behavior of WebContent's GetLastCommittedURL() and GetVisibleURL() from
1960 // before we have initial NavigationEntries.
Peter Kasting8104ba82024-01-31 15:23:401961 params->url = GURL();
Rakina Zata Amniafd3c6582021-11-30 06:19:171962 params->http_status_code = 0;
1963 params->url_is_unreachable = false;
1964 params->method = "GET";
Rakina Zata Amniafd3c6582021-11-30 06:19:171965 params->post_id = -1;
1966 params->embedding_token = base::UnguessableToken::Create();
1967 params->navigation_token = base::UnguessableToken::Create();
1968 params->did_create_new_entry = true;
1969 params->origin = rfh->GetLastCommittedOrigin();
1970 params->should_update_history = true;
1971 params->item_sequence_number = 0;
1972 params->document_sequence_number = 0;
Abhijeet Kandalkare26014a92022-10-13 04:21:151973 bool is_in_fenced_frame_tree = rfh->IsNestedWithinFencedFrame();
Rakina Zata Amniafd3c6582021-11-30 06:19:171974 params->transition = is_in_fenced_frame_tree
1975 ? ui::PAGE_TRANSITION_AUTO_SUBFRAME
1976 : ui::PAGE_TRANSITION_LINK;
1977 params->referrer = blink::mojom::Referrer::New();
1978
Rakina Zata Amniafd3c6582021-11-30 06:19:171979 auto new_entry = std::make_unique<NavigationEntryImpl>(
1980 rfh->GetSiteInstance(), params->url, Referrer(*params->referrer),
W. James MacLean78e2f872023-01-24 17:59:381981 rfh->GetLastCommittedOrigin(), rfh->GetInheritedBaseUrl(),
W. James MacLean23e90a12022-12-21 04:38:211982 std::u16string() /* title */, ui::PAGE_TRANSITION_TYPED,
1983 false /* renderer_initiated */, nullptr /* blob_url_loader_factory */,
1984 true /* is_initial_entry */);
Rakina Zata Amniafd3c6582021-11-30 06:19:171985 UpdateNavigationEntryDetails(
1986 new_entry.get(), rfh, *params, nullptr /* request */,
Rakina Zata Amnia4e27222021-12-22 01:05:001987 NavigationEntryImpl::UpdatePolicy::kUpdate, true /* is_new_entry */,
1988 nullptr /* commit_details */);
Rakina Zata Amniafd3c6582021-11-30 06:19:171989
1990 InsertOrReplaceEntry(std::move(new_entry), false /* replace_entry */,
1991 false /* was_post_commit_error */,
Rakina Zata Amnia4e27222021-12-22 01:05:001992 is_in_fenced_frame_tree, nullptr /* commit_details */);
Rakina Zata Amniafd3c6582021-11-30 06:19:171993}
1994
Charlie Reisc0f17d2d2021-01-12 18:52:491995void NavigationControllerImpl::RendererDidNavigateToNewEntry(
creis3da03872015-02-20 21:12:321996 RenderFrameHostImpl* rfh,
arthursonzogni73fe3212020-11-17 13:24:071997 const mojom::DidCommitProvisionalLoadParams& params,
eugenebut604866f2017-05-10 21:35:361998 bool is_same_document,
clamy3bf35e3c2016-11-10 15:59:441999 bool replace_entry,
Shivani Sharmaeef521b2024-01-18 13:03:562000 bool previous_document_had_history_intervention_activation,
Rakina Zata Amnia4e27222021-12-22 01:05:002001 NavigationRequest* request,
2002 LoadCommittedDetails* commit_details) {
dcheng9bfa5162016-04-09 01:00:572003 std::unique_ptr<NavigationEntryImpl> new_entry;
Arthur Sonzognic686e8f2024-01-11 08:36:372004 const std::optional<url::Origin>& initiator_origin =
Mohamed Abdelhalim833de902019-09-16 17:41:452005 request->common_params().initiator_origin;
Arthur Sonzognic686e8f2024-01-11 08:36:372006 std::optional<GURL> initiator_base_url;
W. James MacLean8be423a2023-03-31 21:35:522007 if (params.url.IsAboutBlank() || params.url.IsAboutSrcdoc()) {
2008 initiator_base_url = request->common_params().initiator_base_url;
2009 }
Lukasz Anforowicz435bcb582019-07-12 20:50:062010
creisf49dfc92016-07-26 17:05:182011 // First check if this is an in-page navigation. If so, clone the current
2012 // entry instead of looking at the pending entry, because the pending entry
2013 // does not have any subframe history items.
Rakina Zata Amnie2d31312022-11-18 03:38:452014 if (is_same_document) {
Nate Chapin63db0d12022-01-20 22:03:302015 FrameNavigationEntry* previous_frame_entry =
2016 GetLastCommittedEntry()->GetFrameEntry(rfh->frame_tree_node());
Patrick Monette50e8bd82019-06-13 22:40:452017 auto frame_entry = base::MakeRefCounted<FrameNavigationEntry>(
Charles Reisd2a509f2017-09-27 23:47:482018 rfh->frame_tree_node()->unique_name(), params.item_sequence_number,
Domenic Denicolacc094fb2022-03-16 23:40:572019 params.document_sequence_number, params.navigation_api_key,
Nate Chapinfbfe5af2021-06-10 17:22:082020 rfh->GetSiteInstance(), nullptr, params.url,
2021 GetCommittedOriginForFrameEntry(params, request),
W. James MacLean23e90a12022-12-21 04:38:212022 Referrer(*params.referrer), initiator_origin, initiator_base_url,
Rakina Zata Amni82fafba2021-03-11 07:07:092023 request->GetRedirectChain(), params.page_state, params.method,
2024 params.post_id, nullptr /* blob_url_loader_factory */,
Antonio Sartori78a749f2020-11-30 12:03:392025 // We will set the document policies later in this function.
Nate Chapin63db0d12022-01-20 22:03:302026 nullptr /* policy_container_policies */,
Domenic Denicolacc094fb2022-03-16 23:40:572027 // Try to preserve protect_url_in_navigation_api from the previous
Nate Chapin63db0d12022-01-20 22:03:302028 // FrameNavigationEntry.
2029 previous_frame_entry &&
Domenic Denicolacc094fb2022-03-16 23:40:572030 previous_frame_entry->protect_url_in_navigation_api());
Charles Reisf44482022017-10-13 21:15:032031
creisf49dfc92016-07-26 17:05:182032 new_entry = GetLastCommittedEntry()->CloneAndReplace(
Ali Hijazid87307d2022-11-07 20:15:032033 frame_entry, true, request->frame_tree_node(), frame_tree_->root());
Mike West800532c2021-10-14 09:26:522034 if (new_entry->GetURL().DeprecatedGetOriginAsURL() !=
2035 params.url.DeprecatedGetOriginAsURL()) {
jama78746e2017-02-22 17:21:572036 // TODO(jam): we had one report of this with a URL that was redirecting to
2037 // only tildes. Until we understand that better, don't copy the cert in
2038 // this case.
2039 new_entry->GetSSL() = SSLStatus();
2040 }
creisf49dfc92016-07-26 17:05:182041
Patrick Monette50e8bd82019-06-13 22:40:452042 // It is expected that |frame_entry| is now owned by |new_entry|. This means
2043 // that |frame_entry| should now have a reference count of exactly 2: one
2044 // due to the local variable |frame_entry|, and another due to |new_entry|
2045 // also retaining one. This should never fail, because it's the main frame.
2046 CHECK(!frame_entry->HasOneRef() && frame_entry->HasAtLeastOneRef());
creisf49dfc92016-07-26 17:05:182047 }
2048
Harkiran Bolaria59290d62021-03-17 01:53:012049 // If this is an activation navigation from a prerendered page, transfer the
2050 // new entry from an entry already created and stored in the
2051 // NavigationRequest. |new_entry| will not have been set prior to this as
2052 // |is_same_document| is mutually exclusive with
2053 // |IsPrerenderedPageActivation|.
2054 if (request->IsPrerenderedPageActivation()) {
2055 DCHECK(!is_same_document);
2056 DCHECK(!new_entry);
2057 new_entry = request->TakePrerenderNavigationEntry();
2058 DCHECK(new_entry);
2059 }
2060
Charlie Reisc0f17d2d2021-01-12 18:52:492061 // Only make a copy of the pending entry if it is appropriate for the new
2062 // document that just loaded. Verify this by checking if the entry corresponds
Mohamed Abdelhalim833de902019-09-16 17:41:452063 // to the given NavigationRequest. Additionally, coarsely check that:
csharrison9a9142bc42016-03-01 17:24:042064 // 1. The SiteInstance hasn't been assigned to something else.
2065 // 2. The pending entry was intended as a new entry, rather than being a
2066 // history navigation that was interrupted by an unrelated,
2067 // renderer-initiated navigation.
2068 // TODO(csharrison): Investigate whether we can remove some of the coarser
2069 // checks.
Mohamed Abdelhalim833de902019-09-16 17:41:452070 if (!new_entry && PendingEntryMatchesRequest(request) &&
2071 pending_entry_index_ == -1 &&
[email protected]6dd86ab2013-02-27 00:30:342072 (!pending_entry_->site_instance() ||
[email protected]27dd82fd2014-03-03 22:11:432073 pending_entry_->site_instance() == rfh->GetSiteInstance())) {
creisef4a0cb2015-03-12 19:14:352074 new_entry = pending_entry_->Clone();
[email protected]e9ba4472008-09-14 15:42:432075
Camille Lamy62b826012019-02-26 09:15:472076 new_entry->GetSSL() =
Mohamed Abdelhalim833de902019-09-16 17:41:452077 SSLStatus(request->GetSSLInfo().value_or(net::SSLInfo()));
creisf49dfc92016-07-26 17:05:182078 }
2079
Charlie Reisc0f17d2d2021-01-12 18:52:492080 // For cross-document commits with no matching pending entry, create a new
2081 // entry.
creisf49dfc92016-07-26 17:05:182082 if (!new_entry) {
Lukasz Anforowicz435bcb582019-07-12 20:50:062083 new_entry = std::make_unique<NavigationEntryImpl>(
arthursonzogni73fe3212020-11-17 13:24:072084 rfh->GetSiteInstance(), params.url, Referrer(*params.referrer),
W. James MacLean23e90a12022-12-21 04:38:212085 initiator_origin, initiator_base_url,
Jan Wilken Dörrieaace0cfef2021-03-11 22:01:582086 std::u16string(), // title
Mohamed Abdelhalim833de902019-09-16 17:41:452087 params.transition, request->IsRendererInitiated(),
Rakina Zata Amniafd3c6582021-11-30 06:19:172088 nullptr, // blob_url_loader_factory
2089 false); // is_initial_entry
[email protected]f8f93eb2012-09-25 03:06:242090
2091 // Find out whether the new entry needs to update its virtual URL on URL
2092 // change and set up the entry accordingly. This is needed to correctly
2093 // update the virtual URL when replaceState is called after a pushState.
2094 GURL url = params.url;
2095 bool needs_update = false;
Charlie Reisc0f17d2d2021-01-12 18:52:492096 // When navigating to a new entry, give the browser URL handler a chance to
[email protected]f1eb87a2011-05-06 17:49:412097 // update the virtual URL based on the new URL. For example, this is needed
2098 // to show chrome://bookmarks/#1 when the bookmarks webui extension changes
2099 // the URL.
Rakina Zata Amni3460d382021-10-29 00:43:372100 BrowserURLHandlerImpl::GetInstance()->RewriteURLIfNecessary(
2101 &url, browser_context_, &needs_update);
2102 new_entry->set_update_virtual_url_with_url(needs_update);
2103
Camille Lamy62b826012019-02-26 09:15:472104 new_entry->GetSSL() =
Mohamed Abdelhalim833de902019-09-16 17:41:452105 SSLStatus(request->GetSSLInfo().value_or(net::SSLInfo()));
[email protected]e9ba4472008-09-14 15:42:432106 }
2107
Alison Gale770f3fc2024-04-27 00:39:582108 // TODO(crbug.com/40169536) - determine which parts of the entry need to be
2109 // set for prerendered contents, if any. This is because
2110 // prerendering/activation technically won't be creating a new document.
2111 // Unlike BFCache, prerendering creates a new NavigationEntry rather than
2112 // using an existing one.
Harkiran Bolaria59290d62021-03-17 01:53:012113 if (!request->IsPrerenderedPageActivation()) {
Rakina Zata Amni3460d382021-10-29 00:43:372114 UpdateNavigationEntryDetails(new_entry.get(), rfh, params, request,
2115 NavigationEntryImpl::UpdatePolicy::kUpdate,
Rakina Zata Amnia4e27222021-12-22 01:05:002116 true /* is_new_entry */, commit_details);
creis8b5cd4c2015-06-19 00:11:082117
Harkiran Bolaria59290d62021-03-17 01:53:012118 // history.pushState() is classified as a navigation to a new page, but sets
2119 // is_same_document to true. In this case, we already have the title and
2120 // favicon available, so set them immediately.
Rakina Zata Amnie2d31312022-11-18 03:38:452121 if (is_same_document) {
Harkiran Bolaria59290d62021-03-17 01:53:012122 new_entry->SetTitle(GetLastCommittedEntry()->GetTitle());
2123 new_entry->GetFavicon() = GetLastCommittedEntry()->GetFavicon();
2124 }
[email protected]3a868f212014-08-09 10:41:192125 }
[email protected]ff64b3e2014-05-31 04:07:332126
[email protected]60d6cca2013-04-30 08:47:132127 DCHECK(!params.history_list_was_cleared || !replace_entry);
2128 // The browser requested to clear the session history when it initiated the
2129 // navigation. Now we know that the renderer has updated its state accordingly
2130 // and it is safe to also clear the browser side history.
2131 if (params.history_list_was_cleared) {
Rakina Zata Amniddf10502022-01-15 02:56:552132 DiscardNonCommittedEntriesWithCommitDetails(commit_details);
[email protected]60d6cca2013-04-30 08:47:132133 entries_.clear();
2134 last_committed_entry_index_ = -1;
2135 }
2136
Nasko Oskovaee2f862018-06-15 00:05:522137 // If this is a new navigation with replacement and there is a
2138 // pending_entry_ which matches the navigation reported by the renderer
2139 // process, then it should be the one replaced, so update the
2140 // last_committed_entry_index_ to use it.
2141 if (replace_entry && pending_entry_index_ != -1 &&
Charlie Reisf8cde712022-10-20 16:25:092142 PendingEntryMatchesRequest(request)) {
Nasko Oskovaee2f862018-06-15 00:05:522143 last_committed_entry_index_ = pending_entry_index_;
2144 }
2145
Alexander Timine3ec4192020-04-20 16:39:402146 SetShouldSkipOnBackForwardUIIfNeeded(
Shivani Sharmaeef521b2024-01-18 13:03:562147 replace_entry, previous_document_had_history_intervention_activation,
Alexander Timine3ec4192020-04-20 16:39:402148 request->IsRendererInitiated(), request->GetPreviousPageUkmSourceId());
shivanisha41f04c52018-12-12 15:52:052149
Yuzu Saijoa725585f2022-11-28 04:14:032150 // If this is a history navigation and the old entry has an existing
2151 // back/forward cache metrics object, keep using the old one so that the
2152 // reasons logged from the last time the page navigated gets preserved.
2153 if (BackForwardCacheMetrics::IsCrossDocumentMainFrameHistoryNavigation(
2154 request)) {
2155 // Use |request->GetNavigationEntry()| instead of |pending_entry_| here
2156 // because some tests do not have a pending entry.
2157 NavigationEntryImpl* entry =
2158 static_cast<NavigationEntryImpl*>(request->GetNavigationEntry());
2159 if (entry && entry->back_forward_cache_metrics()) {
2160 scoped_refptr<BackForwardCacheMetrics> metrics =
2161 entry->TakeBackForwardCacheMetrics();
2162 new_entry->set_back_forward_cache_metrics(std::move(metrics));
2163 }
2164 }
2165
Carlos IL42b416592019-10-07 23:10:362166 InsertOrReplaceEntry(std::move(new_entry), replace_entry,
Dave Tapuska87696ae2021-11-18 18:48:312167 !request->post_commit_error_page_html().empty(),
Abhijeet Kandalkare26014a92022-10-13 04:21:152168 rfh->IsNestedWithinFencedFrame(), commit_details);
[email protected]e9ba4472008-09-14 15:42:432169}
2170
Charlie Reisc0f17d2d2021-01-12 18:52:492171void NavigationControllerImpl::RendererDidNavigateToExistingEntry(
creis3da03872015-02-20 21:12:322172 RenderFrameHostImpl* rfh,
arthursonzogni73fe3212020-11-17 13:24:072173 const mojom::DidCommitProvisionalLoadParams& params,
eugenebut604866f2017-05-10 21:35:362174 bool is_same_document,
jam48cea9082017-02-15 06:13:292175 bool was_restored,
Mohamed Abdelhalim833de902019-09-16 17:41:452176 NavigationRequest* request,
Rakina Zata Amnia4e27222021-12-22 01:05:002177 bool keep_pending_entry,
2178 LoadCommittedDetails* commit_details) {
creis26d22632017-04-21 20:23:562179 DCHECK(GetLastCommittedEntry()) << "ClassifyNavigation should guarantee "
2180 << "that a last committed entry exists.";
2181
[email protected]e9ba4472008-09-14 15:42:432182 // We should only get here for main frame navigations.
avi39c1edd32015-06-04 20:06:002183 DCHECK(!rfh->GetParent());
[email protected]e9ba4472008-09-14 15:42:432184
Charlie Reis7e2cb6d2021-01-26 01:27:162185 NavigationEntryImpl* entry = nullptr;
Rakina Zata Amni153d5702021-09-13 22:48:002186 if (request->commit_params().intended_as_new_entry) {
Charlie Reis7e2cb6d2021-01-26 01:27:162187 // We're guaranteed to have a last committed entry if intended_as_new_entry
2188 // is true.
avicbdc4c12015-07-01 16:07:112189 entry = GetLastCommittedEntry();
Charlie Reis7e2cb6d2021-01-26 01:27:162190
2191 // If the NavigationRequest matches a new pending entry and is classified as
2192 // EXISTING_ENTRY, then it is a navigation to the same URL that was
2193 // converted to a reload, such as a user pressing enter in the omnibox.
Charlie Reisf8cde712022-10-20 16:25:092194 if (pending_entry_index_ == -1 && PendingEntryMatchesRequest(request)) {
Charlie Reis7e2cb6d2021-01-26 01:27:162195 // Note: The pending entry will usually have a real ReloadType here, but
2196 // it can still be ReloadType::NONE in cases that
2197 // ShouldTreatNavigationAsReload returns false (e.g., POST, view-source).
2198
2199 // If we classified this correctly, the SiteInstance should not have
2200 // changed.
2201 CHECK_EQ(entry->site_instance(), rfh->GetSiteInstance());
2202
2203 // For converted reloads, we assign the entry's unique ID to be that of
2204 // the new one. Since this is always the result of a user action, we want
2205 // to dismiss infobars, etc. like a regular user-initiated navigation.
2206 entry->set_unique_id(pending_entry_->GetUniqueID());
2207
2208 // The extra headers may have changed due to reloading with different
2209 // headers.
2210 entry->set_extra_headers(pending_entry_->extra_headers());
2211 }
2212 // Otherwise, this was intended as a new entry but the pending entry was
2213 // lost in the meantime and no new entry was created. We are stuck at the
2214 // last committed entry.
2215
2216 // Even if this is a converted reload from pressing enter in the omnibox,
2217 // the server could redirect, requiring an update to the SSL status. If this
2218 // is a same document navigation, though, there's no SSLStatus in the
Mohamed Abdelhalim833de902019-09-16 17:41:452219 // NavigationRequest so don't overwrite the existing entry's SSLStatus.
Charlie Reis7e2cb6d2021-01-26 01:27:162220 if (!is_same_document) {
Camille Lamy62b826012019-02-26 09:15:472221 entry->GetSSL() =
Mohamed Abdelhalim833de902019-09-16 17:41:452222 SSLStatus(request->GetSSLInfo().value_or(net::SSLInfo()));
Charlie Reis7e2cb6d2021-01-26 01:27:162223 }
Rakina Zata Amnif6950d552020-11-24 03:26:102224 } else if (const int nav_entry_id = request->commit_params().nav_entry_id) {
avicbdc4c12015-07-01 16:07:112225 // This is a browser-initiated navigation (back/forward/reload).
Rakina Zata Amnif6950d552020-11-24 03:26:102226 entry = GetEntryWithUniqueID(nav_entry_id);
jamd208b902016-09-01 16:58:162227
eugenebut604866f2017-05-10 21:35:362228 if (is_same_document) {
Mohamed Abdelhalim833de902019-09-16 17:41:452229 // There's no SSLStatus in the NavigationRequest for same document
eugenebut604866f2017-05-10 21:35:362230 // navigations, so normally we leave |entry|'s SSLStatus as is. However if
2231 // this was a restored same document navigation entry, then it won't have
2232 // an SSLStatus. So we need to copy over the SSLStatus from the entry that
2233 // navigated it.
jam48cea9082017-02-15 06:13:292234 NavigationEntryImpl* last_entry = GetLastCommittedEntry();
Mike West800532c2021-10-14 09:26:522235 if (entry->GetURL().DeprecatedGetOriginAsURL() ==
2236 last_entry->GetURL().DeprecatedGetOriginAsURL() &&
jam48cea9082017-02-15 06:13:292237 last_entry->GetSSL().initialized && !entry->GetSSL().initialized &&
2238 was_restored) {
2239 entry->GetSSL() = last_entry->GetSSL();
2240 }
2241 } else {
Mohamed Abdelhalim833de902019-09-16 17:41:452242 // In rapid back/forward navigations |request| sometimes won't have a cert
2243 // (http://crbug.com/727892). So we use the request's cert if it exists,
John Abd-El-Malek3f247082017-12-07 19:02:192244 // otherwise we only reuse the existing cert if the origins match.
Mohamed Abdelhalim833de902019-09-16 17:41:452245 if (request->GetSSLInfo().has_value() &&
2246 request->GetSSLInfo()->is_valid()) {
2247 entry->GetSSL() = SSLStatus(*(request->GetSSLInfo()));
Mike West800532c2021-10-14 09:26:522248 } else if (entry->GetURL().DeprecatedGetOriginAsURL() !=
2249 request->GetURL().DeprecatedGetOriginAsURL()) {
John Abd-El-Malek3f247082017-12-07 19:02:192250 entry->GetSSL() = SSLStatus();
2251 }
jam48cea9082017-02-15 06:13:292252 }
avicbdc4c12015-07-01 16:07:112253 } else {
Feifei Wang2ab8ba6c2022-04-13 22:19:272254 // This is renderer-initiated. The only kinds of renderer-initiated
Rakina Zata Amni557afb92021-07-17 04:39:572255 // navigations that are EXISTING_ENTRY are same-document navigations that
2256 // result in replacement (e.g. history.replaceState(), location.replace(),
2257 // forced replacements for trivial session history contexts). For these
2258 // cases, we reuse the last committed entry.
avicbdc4c12015-07-01 16:07:112259 entry = GetLastCommittedEntry();
jam0576b132016-09-07 05:13:102260
Alison Gale81f4f2c72024-04-22 19:33:312261 // TODO(crbug.com/40532777): Set page transition type to
2262 // PAGE_TRANSITION_LINK to avoid misleading interpretations (e.g. URLs
2263 // paired with PAGE_TRANSITION_TYPED that haven't actually been typed) as
2264 // well as to fix the inconsistency with what we report to observers
2265 // (PAGE_TRANSITION_LINK | PAGE_TRANSITION_CLIENT_REDIRECT).
Mikel Astizba9cf2fd2017-12-17 10:38:102266
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572267 CopyReplacedNavigationEntryDataIfPreviouslyEmpty(entry, entry);
Mikel Astizba9cf2fd2017-12-17 10:38:102268
eugenebut604866f2017-05-10 21:35:362269 // If this is a same document navigation, then there's no SSLStatus in the
Mohamed Abdelhalim833de902019-09-16 17:41:452270 // NavigationRequest so don't overwrite the existing entry's SSLStatus.
eugenebut604866f2017-05-10 21:35:362271 if (!is_same_document)
Camille Lamy62b826012019-02-26 09:15:472272 entry->GetSSL() =
Mohamed Abdelhalim833de902019-09-16 17:41:452273 SSLStatus(request->GetSSLInfo().value_or(net::SSLInfo()));
avicbdc4c12015-07-01 16:07:112274 }
2275 DCHECK(entry);
[email protected]e9ba4472008-09-14 15:42:432276
Rakina Zata Amni3460d382021-10-29 00:43:372277 UpdateNavigationEntryDetails(entry, rfh, params, request,
2278 NavigationEntryImpl::UpdatePolicy::kUpdate,
Rakina Zata Amnia4e27222021-12-22 01:05:002279 false /* is_new_entry */, commit_details);
creis22a7b4c2016-04-28 07:20:302280
[email protected]5ccd4dc2012-10-24 02:28:142281 // The redirected to page should not inherit the favicon from the previous
2282 // page.
eugenebut604866f2017-05-10 21:35:362283 if (ui::PageTransitionIsRedirect(params.transition) && !is_same_document)
[email protected]91a4ff82012-10-29 20:29:482284 entry->GetFavicon() = FaviconStatus();
[email protected]5ccd4dc2012-10-24 02:28:142285
Charlie Reis951f43372023-05-05 00:30:072286 // Update the last committed index to reflect the committed entry. Do this
2287 // before calling DiscardNonCommittedEntriesWithCommitDetails, so that the
2288 // delegate sees the correct committed index when notified of navigation
2289 // state changes. (Otherwise CanGoBack may incorrectly return true, as in
2290 // https://crbug.com/1439948.)
Charlie Reisfbe5f1022023-10-03 15:21:212291 last_committed_entry_index_ = GetIndexOfEntry(entry);
Charlie Reis951f43372023-05-05 00:30:072292
Peter Boströmd7592132019-01-30 04:50:312293 // We should also usually discard the pending entry if it corresponds to a
2294 // different navigation, since that one is now likely canceled. In rare
2295 // cases, we leave the pending entry for another navigation in place when we
2296 // know it is still ongoing, to avoid a flicker in the omnibox (see
2297 // https://crbug.com/900036).
[email protected]e9ba4472008-09-14 15:42:432298 //
2299 // Note that we need to use the "internal" version since we don't want to
2300 // actually change any other state, just kill the pointer.
Peter Boströmd7592132019-01-30 04:50:312301 if (!keep_pending_entry)
Rakina Zata Amnia4e27222021-12-22 01:05:002302 DiscardNonCommittedEntriesWithCommitDetails(commit_details);
[email protected]e9ba4472008-09-14 15:42:432303}
2304
[email protected]d202a7c2012-01-04 07:53:472305void NavigationControllerImpl::RendererDidNavigateNewSubframe(
creis3da03872015-02-20 21:12:322306 RenderFrameHostImpl* rfh,
arthursonzogni73fe3212020-11-17 13:24:072307 const mojom::DidCommitProvisionalLoadParams& params,
eugenebut604866f2017-05-10 21:35:362308 bool is_same_document,
Shivani Sharmaffb32b82019-04-09 16:58:472309 bool replace_entry,
Shivani Sharmaeef521b2024-01-18 13:03:562310 bool previous_document_had_history_intervention_activation,
Rakina Zata Amnia4e27222021-12-22 01:05:002311 NavigationRequest* request,
2312 LoadCommittedDetails* commit_details) {
avi25f5f9e2015-07-17 20:08:262313 DCHECK(ui::PageTransitionCoreTypeIs(params.transition,
2314 ui::PAGE_TRANSITION_MANUAL_SUBFRAME));
Rakina Zata Amniddf10502022-01-15 02:56:552315 // The NEW_SUBFRAME path should never result in an initial NavigationEntry.
2316 DCHECK(!commit_details->should_stay_as_initial_entry);
[email protected]09b8f82f2009-06-16 20:22:112317
[email protected]e9ba4472008-09-14 15:42:432318 // Manual subframe navigations just get the current entry cloned so the user
2319 // can go back or forward to it. The actual subframe information will be
2320 // stored in the page state for each of those entries. This happens out of
2321 // band with the actual navigations.
[email protected]4c27ba82008-09-24 16:49:092322 DCHECK(GetLastCommittedEntry()) << "ClassifyNavigation should guarantee "
2323 << "that a last committed entry exists.";
creis96fc55082015-06-13 06:42:382324
Mikel Astizba9cf2fd2017-12-17 10:38:102325 // The DCHECK below documents the fact that we don't know of any situation
2326 // where |replace_entry| is true for subframe navigations. This simplifies
2327 // reasoning about the replacement struct for subframes (see
2328 // CopyReplacedNavigationEntryDataIfPreviouslyEmpty()).
2329 DCHECK(!replace_entry);
2330
Patrick Monette50e8bd82019-06-13 22:40:452331 // This FrameNavigationEntry might not end up being used in the
2332 // CloneAndReplace() call below, if a spot can't be found for it in the tree.
Arthur Sonzognic686e8f2024-01-11 08:36:372333 const std::optional<url::Origin>& initiator_origin =
Mohamed Abdelhalim833de902019-09-16 17:41:452334 request->common_params().initiator_origin;
Arthur Sonzognic686e8f2024-01-11 08:36:372335 std::optional<GURL> initiator_base_url;
W. James MacLean8be423a2023-03-31 21:35:522336 if (params.url.IsAboutBlank() || params.url.IsAboutSrcdoc()) {
2337 initiator_base_url = request->common_params().initiator_base_url;
2338 }
Nate Chapin63db0d12022-01-20 22:03:302339 std::unique_ptr<PolicyContainerPolicies> policy_container_policies =
2340 ComputePolicyContainerPoliciesForFrameEntry(rfh, is_same_document,
2341 request->GetURL());
Domenic Denicolacc094fb2022-03-16 23:40:572342 bool protect_url_in_navigation_api = false;
Nate Chapin63db0d12022-01-20 22:03:302343 if (is_same_document) {
2344 FrameNavigationEntry* previous_frame_entry =
2345 GetLastCommittedEntry()->GetFrameEntry(rfh->frame_tree_node());
Domenic Denicolacc094fb2022-03-16 23:40:572346 // Try to preserve protect_url_in_navigation_api from the previous
Nate Chapin63db0d12022-01-20 22:03:302347 // FrameNavigationEntry.
Domenic Denicolacc094fb2022-03-16 23:40:572348 protect_url_in_navigation_api =
Nate Chapin63db0d12022-01-20 22:03:302349 previous_frame_entry &&
Domenic Denicolacc094fb2022-03-16 23:40:572350 previous_frame_entry->protect_url_in_navigation_api();
Nate Chapin63db0d12022-01-20 22:03:302351 } else {
Domenic Denicolacc094fb2022-03-16 23:40:572352 protect_url_in_navigation_api =
Nate Chapin63db0d12022-01-20 22:03:302353 policy_container_policies &&
Domenic Denicolacc094fb2022-03-16 23:40:572354 ShouldProtectUrlInNavigationApi(
Nate Chapin63db0d12022-01-20 22:03:302355 policy_container_policies->referrer_policy);
2356 }
2357
Patrick Monette50e8bd82019-06-13 22:40:452358 auto frame_entry = base::MakeRefCounted<FrameNavigationEntry>(
Charles Reisd2a509f2017-09-27 23:47:482359 rfh->frame_tree_node()->unique_name(), params.item_sequence_number,
Domenic Denicolacc094fb2022-03-16 23:40:572360 params.document_sequence_number, params.navigation_api_key,
Nate Chapinfbfe5af2021-06-10 17:22:082361 rfh->GetSiteInstance(), nullptr, params.url,
2362 GetCommittedOriginForFrameEntry(params, request),
W. James MacLean23e90a12022-12-21 04:38:212363 Referrer(*params.referrer), initiator_origin, initiator_base_url,
2364 request->GetRedirectChain(), params.page_state, params.method,
2365 params.post_id, nullptr /* blob_url_loader_factory */,
Domenic Denicolacc094fb2022-03-16 23:40:572366 std::move(policy_container_policies), protect_url_in_navigation_api);
Charles Reisf44482022017-10-13 21:15:032367
creisce0ef3572017-01-26 17:53:082368 std::unique_ptr<NavigationEntryImpl> new_entry =
2369 GetLastCommittedEntry()->CloneAndReplace(
Patrick Monette50e8bd82019-06-13 22:40:452370 std::move(frame_entry), is_same_document, rfh->frame_tree_node(),
Ali Hijazid87307d2022-11-07 20:15:032371 frame_tree_->root());
creise062d542015-08-25 02:01:552372
Alexander Timine3ec4192020-04-20 16:39:402373 SetShouldSkipOnBackForwardUIIfNeeded(
Shivani Sharmaeef521b2024-01-18 13:03:562374 replace_entry, previous_document_had_history_intervention_activation,
Alexander Timine3ec4192020-04-20 16:39:402375 request->IsRendererInitiated(), request->GetPreviousPageUkmSourceId());
Shivani Sharmaffb32b82019-04-09 16:58:472376
creisce0ef3572017-01-26 17:53:082377 // TODO(creis): Update this to add the frame_entry if we can't find the one
Patrick Monette50e8bd82019-06-13 22:40:452378 // to replace, which can happen due to a unique name change. See
2379 // https://crbug.com/607205. For now, the call to CloneAndReplace() will
2380 // delete the |frame_entry| when the function exits if it doesn't get used.
creis96fc55082015-06-13 06:42:382381
Dave Tapuska87696ae2021-11-18 18:48:312382 InsertOrReplaceEntry(std::move(new_entry), replace_entry, false,
Abhijeet Kandalkare26014a92022-10-13 04:21:152383 rfh->IsNestedWithinFencedFrame(), commit_details);
[email protected]e9ba4472008-09-14 15:42:432384}
2385
[email protected]d202a7c2012-01-04 07:53:472386bool NavigationControllerImpl::RendererDidNavigateAutoSubframe(
creis3da03872015-02-20 21:12:322387 RenderFrameHostImpl* rfh,
arthursonzogni73fe3212020-11-17 13:24:072388 const mojom::DidCommitProvisionalLoadParams& params,
Antonio Sartori78a749f2020-11-30 12:03:392389 bool is_same_document,
Nate Chapinc7019dd7d2021-06-25 18:29:252390 bool was_on_initial_empty_document,
Rakina Zata Amnia4e27222021-12-22 01:05:002391 NavigationRequest* request,
2392 LoadCommittedDetails* commit_details) {
avi9f07a0c2015-02-18 22:51:292393 DCHECK(ui::PageTransitionCoreTypeIs(params.transition,
2394 ui::PAGE_TRANSITION_AUTO_SUBFRAME));
2395
[email protected]e9ba4472008-09-14 15:42:432396 // We're guaranteed to have a previously committed entry, and we now need to
2397 // handle navigation inside of a subframe in it without creating a new entry.
2398 DCHECK(GetLastCommittedEntry());
2399
creis913c63ce2016-07-16 19:52:522400 // For newly created subframes, we don't need to send a commit notification.
2401 // This is only necessary for history navigations in subframes.
2402 bool send_commit_notification = false;
2403
Rakina Zata Amnif6950d552020-11-24 03:26:102404 // If |nav_entry_id| is non-zero and matches an existing entry, this
2405 // is a history navigation. Update the last committed index accordingly. If
2406 // we don't recognize the |nav_entry_id|, it might be a recently
2407 // pruned entry. We'll handle it below.
2408 if (const int nav_entry_id = request->commit_params().nav_entry_id) {
2409 int entry_index = GetEntryIndexWithUniqueID(nav_entry_id);
creis3cdc3b02015-05-29 23:00:472410 if (entry_index != -1 && entry_index != last_committed_entry_index_) {
avi98405c22015-05-21 20:47:062411 // Make sure that a subframe commit isn't changing the main frame's
2412 // origin. Otherwise the renderer process may be confused, leading to a
2413 // URL spoof. We can't check the path since that may change
2414 // (https://crbug.com/373041).
creis37988b92016-06-10 18:03:572415 // TODO(creis): For now, restrict this check to HTTP(S) origins, because
2416 // about:blank, file, and unique origins are more subtle to get right.
Charlie Reis95fbca442021-05-21 21:38:242417 // We should use checks similar to RenderFrameHostImpl's
2418 // CanCommitUrlAndOrigin on the main frame during subframe commits.
2419 // See https://crbug.com/1209092.
creis37988b92016-06-10 18:03:572420 const GURL& dest_top_url = GetEntryAtIndex(entry_index)->GetURL();
2421 const GURL& current_top_url = GetLastCommittedEntry()->GetURL();
2422 if (current_top_url.SchemeIsHTTPOrHTTPS() &&
2423 dest_top_url.SchemeIsHTTPOrHTTPS() &&
Mike West800532c2021-10-14 09:26:522424 current_top_url.DeprecatedGetOriginAsURL() !=
2425 dest_top_url.DeprecatedGetOriginAsURL()) {
Chris Bookholt10f4b7332022-02-14 18:25:442426 bad_message::ReceivedBadMessage(rfh->GetMainFrame()->GetProcess(),
creisfb6eeb62016-05-10 19:01:512427 bad_message::NC_AUTO_SUBFRAME);
avi98405c22015-05-21 20:47:062428 }
creis3cdc3b02015-05-29 23:00:472429
creis913c63ce2016-07-16 19:52:522430 // We only need to discard the pending entry in this history navigation
2431 // case. For newly created subframes, there was no pending entry.
avi98405c22015-05-21 20:47:062432 last_committed_entry_index_ = entry_index;
Rakina Zata Amnia4e27222021-12-22 01:05:002433 DiscardNonCommittedEntriesWithCommitDetails(commit_details);
creis913c63ce2016-07-16 19:52:522434
2435 // History navigations should send a commit notification.
2436 send_commit_notification = true;
avi98405c22015-05-21 20:47:062437 }
[email protected]e9ba4472008-09-14 15:42:432438 }
[email protected]f233e4232013-02-23 00:55:142439
creisce0ef3572017-01-26 17:53:082440 // This may be a "new auto" case where we add a new FrameNavigationEntry, or
2441 // it may be a "history auto" case where we update an existing one.
Nate Chapin9f169072021-06-09 19:32:372442 // We may want to update |last_committed|'s FrameNavigationEntry (if one
2443 // exists), or we may want to clobber it and create a new one. We update in
2444 // cases where the corresponding FrameNavigationEntry is conceptually similar
2445 // to the document described by the commit params: same-document
2446 // navigations, history traversal to an existing entry, and reloads (including
2447 // a "soft reload" where we navigate to the same url without flagging it as a
2448 // reload). But in the case of a different document that is not logically
2449 // related to the committed FrameNavigationEntry's document (cross-document,
2450 // not same url, not a reload, not a history traversal), we replace rather
2451 // than update.
Nate Chapinc7019dd7d2021-06-25 18:29:252452 //
Nate Chapin9f169072021-06-09 19:32:372453 // In the case where we update, the FrameNavigationEntry will potentially be
2454 // shared across multiple NavigationEntries, and any updates will be reflected
2455 // in all of those NavigationEntries. In the replace case, any existing
2456 // sharing with other NavigationEntries will stop.
Nate Chapinc7019dd7d2021-06-25 18:29:252457 //
2458 // When navigating away from the initial empty document, we also update rather
2459 // than replace. Either update or replace will overwrite the initial empty
2460 // document state for |last_committed|, but if the FrameNavigationEntry for
2461 // the initial empty document is shared across multiple NavigationEntries (due
2462 // to a navigation in another frame), we want to make sure we overwrite the
2463 // initial empty document state everywhere this FrameNavigationEntry is used,
2464 // which is accompished by updating the existing FrameNavigationEntry.
Rakina Zata Amnie2d31312022-11-18 03:38:452465 NavigationEntryImpl* last_committed = GetLastCommittedEntry();
Nate Chapin9f169072021-06-09 19:32:372466 FrameNavigationEntry* last_committed_frame_entry =
2467 last_committed->GetFrameEntry(rfh->frame_tree_node());
2468 NavigationEntryImpl::UpdatePolicy update_policy =
2469 NavigationEntryImpl::UpdatePolicy::kUpdate;
2470 if (request->common_params().navigation_type ==
Minggang Wangb9f3fa92021-07-01 15:30:312471 blink::mojom::NavigationType::DIFFERENT_DOCUMENT &&
Nate Chapin9f169072021-06-09 19:32:372472 last_committed_frame_entry &&
Nate Chapinc7019dd7d2021-06-25 18:29:252473 last_committed_frame_entry->url() != params.url &&
2474 !was_on_initial_empty_document) {
Nate Chapin9f169072021-06-09 19:32:372475 update_policy = NavigationEntryImpl::UpdatePolicy::kReplace;
2476 }
2477
Rakina Zata Amni3460d382021-10-29 00:43:372478 UpdateNavigationEntryDetails(last_committed, rfh, params, request,
Rakina Zata Amnia4e27222021-12-22 01:05:002479 update_policy, false /* is_new_entry */,
2480 commit_details);
creis625a0c7d2015-03-24 23:17:122481
creis913c63ce2016-07-16 19:52:522482 return send_commit_notification;
[email protected]e9ba4472008-09-14 15:42:432483}
2484
[email protected]d202a7c2012-01-04 07:53:472485int NavigationControllerImpl::GetIndexOfEntry(
[email protected]10f417c52011-12-28 21:04:232486 const NavigationEntryImpl* entry) const {
avif16f85a72015-11-13 18:25:032487 for (size_t i = 0; i < entries_.size(); ++i) {
2488 if (entries_[i].get() == entry)
2489 return i;
2490 }
2491 return -1;
[email protected]765b35502008-08-21 00:51:202492}
2493
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572494void NavigationControllerImpl::CopyStateFrom(NavigationController* temp,
Francois Dorayeaace782017-06-21 16:37:242495 bool needs_reload) {
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572496 NavigationControllerImpl* source =
2497 static_cast<NavigationControllerImpl*>(temp);
[email protected]ce3fa3c2009-04-20 19:55:572498 // Verify that we look new.
Rakina Zata Amni46087a12022-11-11 08:28:382499 DCHECK_EQ(1, GetEntryCount());
2500 DCHECK(GetLastCommittedEntry()->IsInitialEntry());
Lei Zhang96031532019-10-10 19:05:472501 DCHECK(!GetPendingEntry());
Rakina Zata Amniafd3c6582021-11-30 06:19:172502 entries_.clear();
[email protected]ce3fa3c2009-04-20 19:55:572503
Francois Dorayeaace782017-06-21 16:37:242504 needs_reload_ = needs_reload;
Bo Liucdfa4b12018-11-06 00:21:442505 needs_reload_type_ = NeedsReloadType::kCopyStateFrom;
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572506 InsertEntriesFrom(source, source->GetEntryCount());
[email protected]ce3fa3c2009-04-20 19:55:572507
Fergal Dalya1d569972021-03-16 03:24:532508 for (auto& it : source->session_storage_namespace_map_) {
[email protected]fdac6ade2013-07-20 01:06:302509 SessionStorageNamespaceImpl* source_namespace =
Fergal Dalya1d569972021-03-16 03:24:532510 static_cast<SessionStorageNamespaceImpl*>(it.second.get());
2511 session_storage_namespace_map_[it.first] = source_namespace->Clone();
[email protected]fdac6ade2013-07-20 01:06:302512 }
[email protected]4e6419c2010-01-15 04:50:342513
Lukasz Anforowicz0de0f452020-12-02 19:57:152514 FinishRestore(source->last_committed_entry_index_, RestoreType::kRestored);
[email protected]ce3fa3c2009-04-20 19:55:572515}
2516
[email protected]79368982013-11-13 01:11:012517bool NavigationControllerImpl::CanPruneAllButLastCommitted() {
Adithya Srinivasane8094c82024-06-26 22:45:022518 // If there is no last committed entry, we cannot prune.
[email protected]474f8512013-05-31 22:31:162519 if (last_committed_entry_index_ == -1)
2520 return false;
[email protected]9350602e2013-02-26 23:27:442521
[email protected]474f8512013-05-31 22:31:162522 // We cannot prune if there is a pending entry at an existing entry index.
2523 // It may not commit, so we have to keep the last committed entry, and thus
2524 // there is no sensible place to keep the pending entry. It is ok to have
2525 // a new pending entry, which can optionally commit as a new navigation.
2526 if (pending_entry_index_ != -1)
2527 return false;
2528
[email protected]474f8512013-05-31 22:31:162529 return true;
2530}
2531
[email protected]79368982013-11-13 01:11:012532void NavigationControllerImpl::PruneAllButLastCommitted() {
2533 PruneAllButLastCommittedInternal();
[email protected]474f8512013-05-31 22:31:162534
avi2b177592014-12-10 02:08:022535 DCHECK_EQ(0, last_committed_entry_index_);
2536 DCHECK_EQ(1, GetEntryCount());
[email protected]9350602e2013-02-26 23:27:442537
Hayato Ito2c8c08d02021-06-23 03:38:432538 BroadcastHistoryOffsetAndLength();
[email protected]9350602e2013-02-26 23:27:442539}
2540
[email protected]79368982013-11-13 01:11:012541void NavigationControllerImpl::PruneAllButLastCommittedInternal() {
[email protected]474f8512013-05-31 22:31:162542 // It is up to callers to check the invariants before calling this.
[email protected]79368982013-11-13 01:11:012543 CHECK(CanPruneAllButLastCommitted());
[email protected]97b6c4f2010-09-27 19:31:262544
Nate Chapin9eb16be72022-09-23 22:54:312545 RemovedEntriesTracker tracker(weak_factory_.GetSafeRef());
2546
[email protected]474f8512013-05-31 22:31:162547 // Erase all entries but the last committed entry. There may still be a
2548 // new pending entry after this.
2549 entries_.erase(entries_.begin(),
2550 entries_.begin() + last_committed_entry_index_);
2551 entries_.erase(entries_.begin() + 1, entries_.end());
2552 last_committed_entry_index_ = 0;
[email protected]97b6c4f2010-09-27 19:31:262553}
2554
Christian Dullweber1af31e62018-02-22 11:49:482555void NavigationControllerImpl::DeleteNavigationEntries(
2556 const DeletionPredicate& deletionPredicate) {
2557 // It is up to callers to check the invariants before calling this.
2558 CHECK(CanPruneAllButLastCommitted());
2559 std::vector<int> delete_indices;
2560 for (size_t i = 0; i < entries_.size(); i++) {
2561 if (i != static_cast<size_t>(last_committed_entry_index_) &&
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572562 deletionPredicate.Run(entries_[i].get())) {
Christian Dullweber1af31e62018-02-22 11:49:482563 delete_indices.push_back(i);
2564 }
2565 }
2566 if (delete_indices.empty())
2567 return;
2568
2569 if (delete_indices.size() == GetEntryCount() - 1U) {
2570 PruneAllButLastCommitted();
2571 } else {
2572 // Do the deletion in reverse to preserve indices.
Ayu Ishii2f825852022-03-08 19:47:382573 for (const auto& index : base::Reversed(delete_indices)) {
2574 RemoveEntryAtIndex(index);
Christian Dullweber1af31e62018-02-22 11:49:482575 }
Hayato Ito2c8c08d02021-06-23 03:38:432576 BroadcastHistoryOffsetAndLength();
Christian Dullweber1af31e62018-02-22 11:49:482577 }
2578 delegate()->NotifyNavigationEntriesDeleted();
2579}
2580
Carlos Caballero35ce710c2019-09-19 10:59:452581BackForwardCacheImpl& NavigationControllerImpl::GetBackForwardCache() {
2582 return back_forward_cache_;
2583}
2584
William Liu055a3542023-04-02 17:21:192585NavigationEntryScreenshotCache*
2586NavigationControllerImpl::GetNavigationEntryScreenshotCache() {
Takashi Toyoshima7c041d82023-09-26 16:09:212587 CHECK(frame_tree_->is_primary());
Khushal Sagar94ea2dc2024-08-06 17:15:262588 if (!nav_entry_screenshot_cache_ &&
2589 NavigationTransitionConfig::AreBackForwardTransitionsEnabled()) {
William Liu055a3542023-04-02 17:21:192590 nav_entry_screenshot_cache_ =
2591 std::make_unique<NavigationEntryScreenshotCache>(
2592 BrowserContextImpl::From(browser_context_)
2593 ->GetNavigationEntryScreenshotManager()
2594 ->GetSafeRef(),
2595 this);
2596 }
2597 return nav_entry_screenshot_cache_.get();
2598}
2599
clamy987a3752018-05-03 17:36:262600void NavigationControllerImpl::DiscardPendingEntry(bool was_failure) {
2601 // It is not safe to call DiscardPendingEntry while NavigateToEntry is in
2602 // progress, since this will cause a use-after-free. (We only allow this
2603 // when the tab is being destroyed for shutdown, since it won't return to
2604 // NavigateToEntry in that case.) http://crbug.com/347742.
Ali Hijazid87307d2022-11-07 20:15:032605 CHECK(!in_navigate_to_pending_entry_ || frame_tree_->IsBeingDestroyed());
clamy987a3752018-05-03 17:36:262606
2607 if (was_failure && pending_entry_) {
2608 failed_pending_entry_id_ = pending_entry_->GetUniqueID();
2609 } else {
2610 failed_pending_entry_id_ = 0;
2611 }
2612
2613 if (pending_entry_) {
2614 if (pending_entry_index_ == -1)
Paul Semel7e51469e2022-07-12 12:16:332615 pending_entry_.ClearAndDelete();
clamy987a3752018-05-03 17:36:262616 pending_entry_index_ = -1;
2617 pending_entry_ = nullptr;
2618 }
arthursonzogni66f711c2019-10-08 14:40:362619
2620 // Ensure any refs to the current pending entry are ignored if they get
2621 // deleted, by clearing the set of known refs. All future pending entries will
2622 // only be affected by new refs.
2623 pending_entry_refs_.clear();
clamy987a3752018-05-03 17:36:262624}
2625
2626void NavigationControllerImpl::SetPendingNavigationSSLError(bool error) {
2627 if (pending_entry_)
2628 pending_entry_->set_ssl_error(error);
2629}
2630
Xiaohan Wang7f8052e02022-01-14 18:44:282631#if BUILDFLAG(IS_ANDROID)
Camille Lamy5193caa2018-10-12 11:59:422632// static
2633bool NavigationControllerImpl::ValidateDataURLAsString(
2634 const scoped_refptr<const base::RefCountedString>& data_url_as_string) {
2635 if (!data_url_as_string)
2636 return false;
2637
2638 if (data_url_as_string->size() > kMaxLengthOfDataURLString)
2639 return false;
2640
2641 // The number of characters that is enough for validating a data: URI.
2642 // From the GURL's POV, the only important part here is scheme, it doesn't
2643 // check the actual content. Thus we can take only the prefix of the url, to
2644 // avoid unneeded copying of a potentially long string.
danakj529a3eba2024-04-18 20:14:562645 constexpr size_t kDataUriPrefixMaxLen = 64;
2646 const size_t len = std::min(data_url_as_string->size(), kDataUriPrefixMaxLen);
2647 GURL data_url(base::as_string_view(*data_url_as_string).substr(0u, len));
Camille Lamy5193caa2018-10-12 11:59:422648 if (!data_url.is_valid() || !data_url.SchemeIs(url::kDataScheme))
2649 return false;
2650
2651 return true;
2652}
2653#endif
2654
Shivani Sharma194877032019-03-07 17:52:472655void NavigationControllerImpl::NotifyUserActivation() {
2656 // When a user activation occurs, ensure that all adjacent entries for the
2657 // same document clear their skippable bit, so that the history manipulation
2658 // intervention does not apply to them.
Lijin Shen9c475d32023-09-02 00:15:012659 const bool can_go_back = CanGoBack();
Shivani Sharmac4cc8922019-04-18 03:11:172660 SetSkippableForSameDocumentEntries(GetLastCommittedEntryIndex(), false);
Lijin Shen9c475d32023-09-02 00:15:012661 // If the value of CanGoBack changes as a result of making some entries
2662 // non-skippable, then we must let the delegate know to update its UI state.
2663 // See https://crbug.com/1477784.
2664 if (!can_go_back && CanGoBack()) {
2665 delegate_->NotifyNavigationStateChangedFromController(INVALIDATE_TYPE_ALL);
2666 }
Shivani Sharma194877032019-03-07 17:52:472667}
2668
clamy987a3752018-05-03 17:36:262669bool NavigationControllerImpl::StartHistoryNavigationInNewSubframe(
2670 RenderFrameHostImpl* render_frame_host,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:332671 mojo::PendingAssociatedRemote<mojom::NavigationClient>* navigation_client,
2672 blink::LocalFrameToken initiator_frame_token,
2673 int initiator_process_id) {
clamy987a3752018-05-03 17:36:262674 NavigationEntryImpl* entry =
2675 GetEntryWithUniqueID(render_frame_host->nav_entry_id());
2676 if (!entry)
2677 return false;
2678
2679 FrameNavigationEntry* frame_entry =
2680 entry->GetFrameEntry(render_frame_host->frame_tree_node());
2681 if (!frame_entry)
2682 return false;
2683
Camille Lamy5193caa2018-10-12 11:59:422684 std::unique_ptr<NavigationRequest> request = CreateNavigationRequestFromEntry(
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572685 render_frame_host->frame_tree_node(), entry, frame_entry,
clamyea99ea12018-05-28 13:54:232686 ReloadType::NONE, false /* is_same_document_history_load */,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:332687 true /* is_history_navigation_in_new_child */, initiator_frame_token,
2688 initiator_process_id);
clamyea99ea12018-05-28 13:54:232689
2690 if (!request)
2691 return false;
2692
arthursonzognif046d4a2019-12-12 19:08:102693 request->SetNavigationClient(std::move(*navigation_client));
Arthur Hemery06173ce2019-05-29 12:11:412694
Rakina Zata Amni1c83b082023-02-08 01:09:002695 SCOPED_CRASH_KEY_STRING256(
2696 "Bug1400009", "req_url",
2697 request->GetURL().GetWithEmptyPath().possibly_invalid_spec());
2698 SCOPED_CRASH_KEY_NUMBER(
2699 "Bug1400009", "nav_entry_si",
2700 entry->site_instance() ? ((int)entry->site_instance()->GetId()) : -1);
2701 SCOPED_CRASH_KEY_NUMBER("Bug1400009", "fne_si",
2702 frame_entry->site_instance()
2703 ? ((int)frame_entry->site_instance()->GetId())
2704 : -1);
2705 bool has_sig =
2706 (frame_entry->site_instance() && frame_entry->site_instance()->group());
2707 SCOPED_CRASH_KEY_BOOL("Bug1400009", "fne_sig_exists", has_sig);
2708 SCOPED_CRASH_KEY_BOOL("Bug1400009", "fne_sig_has_rvh",
2709 has_sig ? (!!frame_tree_->GetRenderViewHost(
2710 frame_entry->site_instance()->group()))
2711 : false);
Lukasz Anforowicz9ee83c272020-12-01 20:14:052712 render_frame_host->frame_tree_node()->navigator().Navigate(std::move(request),
2713 ReloadType::NONE);
clamyea99ea12018-05-28 13:54:232714
2715 return true;
clamy987a3752018-05-03 17:36:262716}
2717
Tsuyoshi Horo52fd08e2020-07-07 07:03:452718bool NavigationControllerImpl::ReloadFrame(FrameTreeNode* frame_tree_node) {
2719 NavigationEntryImpl* entry = GetEntryAtIndex(GetCurrentEntryIndex());
2720 if (!entry)
2721 return false;
Rakina Zata Amnif297a802022-01-18 03:53:432722
2723 if (entry->IsInitialEntryNotForSynchronousAboutBlank()) {
2724 // We should never navigate to an existing initial NavigationEntry that is
2725 // the initial NavigationEntry for the initial empty document that hasn't
2726 // been overridden by the synchronous about:blank commit, to preserve
2727 // legacy behavior where trying to reload when the main frame is on the
2728 // initial empty document won't result in a navigation. See also
2729 // https://crbug.com/1277414.
2730 return false;
2731 }
Tsuyoshi Horo52fd08e2020-07-07 07:03:452732 FrameNavigationEntry* frame_entry = entry->GetFrameEntry(frame_tree_node);
2733 if (!frame_entry)
2734 return false;
John Abd-El-Malek5b669132020-07-14 01:04:142735 ReloadType reload_type = ReloadType::NORMAL;
2736 entry->set_reload_type(reload_type);
Tsuyoshi Horo52fd08e2020-07-07 07:03:452737 std::unique_ptr<NavigationRequest> request = CreateNavigationRequestFromEntry(
John Abd-El-Malek5b669132020-07-14 01:04:142738 frame_tree_node, entry, frame_entry, reload_type,
Tsuyoshi Horo52fd08e2020-07-07 07:03:452739 false /* is_same_document_history_load */,
Nate Chapin45f620582021-09-30 17:45:432740 false /* is_history_navigation_in_new_child */,
Arthur Sonzognic686e8f2024-01-11 08:36:372741 std::nullopt /* initiator_frame_token */,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:332742 ChildProcessHost::kInvalidUniqueID /* initiator_process_id */);
Tsuyoshi Horo52fd08e2020-07-07 07:03:452743 if (!request)
2744 return false;
Lukasz Anforowicz9ee83c272020-12-01 20:14:052745 frame_tree_node->navigator().Navigate(std::move(request), reload_type);
Tsuyoshi Horo52fd08e2020-07-07 07:03:452746 return true;
2747}
2748
clamy987a3752018-05-03 17:36:262749void NavigationControllerImpl::NavigateFromFrameProxy(
2750 RenderFrameHostImpl* render_frame_host,
2751 const GURL& url,
Chris Hamilton83272dc2021-02-23 00:24:022752 const blink::LocalFrameToken* initiator_frame_token,
Antonio Sartori9a82f6f32020-12-14 09:22:452753 int initiator_process_id,
Arthur Sonzognic686e8f2024-01-11 08:36:372754 const std::optional<url::Origin>& initiator_origin,
2755 const std::optional<GURL>& initiator_base_url,
clamy987a3752018-05-03 17:36:262756 bool is_renderer_initiated,
2757 SiteInstance* source_site_instance,
2758 const Referrer& referrer,
2759 ui::PageTransition page_transition,
2760 bool should_replace_current_entry,
Yeunjoo Choi3df791a2021-02-17 07:07:252761 blink::NavigationDownloadPolicy download_policy,
clamy987a3752018-05-03 17:36:262762 const std::string& method,
2763 scoped_refptr<network::ResourceRequestBody> post_body,
Marijn Kruisselbrink7a0d5e182018-05-24 22:55:092764 const std::string& extra_headers,
Antonio Sartori2f763d9d2021-04-21 10:04:142765 network::mojom::SourceLocationPtr source_location,
John Delaney50425f82020-04-07 16:26:212766 scoped_refptr<network::SharedURLLoaderFactory> blob_url_loader_factory,
jongdeok.kim5de823b32022-06-14 04:37:502767 bool is_form_submission,
Arthur Sonzognic686e8f2024-01-11 08:36:372768 const std::optional<blink::Impression>& impression,
Yao Xiao720ef9d62022-12-09 05:18:292769 blink::mojom::NavigationInitiatorActivationAndAdStatus
2770 initiator_activation_and_ad_status,
Nan Lin944e9b4e2022-04-12 13:51:222771 base::TimeTicks navigation_start_time,
Garrett Tanzer405f3402022-07-21 20:12:492772 bool is_embedder_initiated_fenced_frame_navigation,
Garrett Tanzerbb8db412022-09-27 21:59:462773 bool is_unfenced_top_navigation,
Sergey Poromovdd557c12023-03-01 11:28:452774 bool force_new_browsing_instance,
Camillia Smith Barnes6a643962023-03-03 00:28:582775 bool is_container_initiated,
Kevin McNee6455638a2024-06-27 22:05:032776 bool has_rel_opener,
W. James MacLean443ef3e2024-07-16 13:42:342777 net::StorageAccessApiStatus storage_access_api_status,
Arthur Sonzognic686e8f2024-01-11 08:36:372778 std::optional<std::u16string> embedder_shared_storage_context) {
Lukasz Anforowicz63f3b9432019-05-30 05:42:582779 if (is_renderer_initiated)
2780 DCHECK(initiator_origin.has_value());
2781
clamy987a3752018-05-03 17:36:262782 FrameTreeNode* node = render_frame_host->frame_tree_node();
Nasko Oskov18006bc2018-12-06 02:53:582783
Rakina Zata Amni2322f4f82022-01-24 13:24:242784 // Don't allow an entry replacement if there is no entry to replace.
2785 // http://crbug.com/457149
2786 if (GetEntryCount() == 0)
2787 should_replace_current_entry = false;
2788
clamy987a3752018-05-03 17:36:262789 // Create a NavigationEntry for the transfer, without making it the pending
2790 // entry. Subframe transfers should have a clone of the last committed entry
2791 // with a FrameNavigationEntry for the target frame. Main frame transfers
2792 // should have a new NavigationEntry.
2793 // TODO(creis): Make this unnecessary by creating (and validating) the params
2794 // directly, passing them to the destination RenderFrameHost. See
2795 // https://crbug.com/536906.
2796 std::unique_ptr<NavigationEntryImpl> entry;
Harkiran Bolariae1b5158b2021-09-16 19:03:262797 if (!render_frame_host->is_main_frame()) {
clamy987a3752018-05-03 17:36:262798 // Subframe case: create FrameNavigationEntry.
Rakina Zata Amnie2d31312022-11-18 03:38:452799 DCHECK(GetLastCommittedEntry());
2800 entry = GetLastCommittedEntry()->Clone();
2801 entry->set_extra_headers(extra_headers);
Rakina Zata Amniafd3c6582021-11-30 06:19:172802 // TODO(arthursonzogni): What about |is_renderer_initiated|?
2803 // Renderer-initiated navigation that target a remote frame are currently
2804 // classified as browser-initiated when this one has already navigated.
2805 // See https://crbug.com/722251.
Nate Chapin9f169072021-06-09 19:32:372806 // The UpdatePolicy doesn't matter here. |entry| is only used as a parameter
2807 // to CreateNavigationRequestFromLoadParams(), so while kReplace might
2808 // remove child FrameNavigationEntries (e.g., if this is a cross-process
2809 // same-document navigation), they will still be present in the
2810 // committed NavigationEntry that will be referenced to construct the new
2811 // FrameNavigationEntry tree when this navigation commits.
clamy987a3752018-05-03 17:36:262812 entry->AddOrUpdateFrameEntry(
Nate Chapinfbfe5af2021-06-10 17:22:082813 node, NavigationEntryImpl::UpdatePolicy::kReplace, -1, -1, "", nullptr,
Nasko Oskov18006bc2018-12-06 02:53:582814 static_cast<SiteInstanceImpl*>(source_site_instance), url,
Arthur Sonzognic686e8f2024-01-11 08:36:372815 std::nullopt /* commit_origin */, referrer, initiator_origin,
W. James MacLean23e90a12022-12-21 04:38:212816 initiator_base_url, std::vector<GURL>(), blink::PageState(), method, -1,
Kunihiko Sakamoto2ae79e62023-05-26 00:34:152817 blob_url_loader_factory, nullptr /* policy_container_policies */);
clamy987a3752018-05-03 17:36:262818 } else {
2819 // Main frame case.
Julie Jeongeun Kim5b9aff72022-05-02 02:10:172820 // If `node` is the outermost main frame, it rewrites a virtual url in order
2821 // to adjust the original input url if needed. For inner frames such as
2822 // fenced frames or subframes, they don't rewrite urls as the urls are not
2823 // input urls by users.
2824 bool rewrite_virtual_urls = node->IsOutermostMainFrame();
Arthur Sonzognic686e8f2024-01-11 08:36:372825 std::optional<GURL> source_process_site_url = std::nullopt;
Sharon Yang242ef822023-05-15 21:07:322826 if (source_site_instance && source_site_instance->HasProcess()) {
2827 source_process_site_url =
2828 source_site_instance->GetProcess()->GetProcessLock().site_url();
2829 }
clamy987a3752018-05-03 17:36:262830 entry = NavigationEntryImpl::FromNavigationEntry(CreateNavigationEntry(
W. James MacLean23e90a12022-12-21 04:38:212831 url, referrer, initiator_origin, initiator_base_url,
Sharon Yang242ef822023-05-15 21:07:322832 source_process_site_url, page_transition, is_renderer_initiated,
W. James MacLean23e90a12022-12-21 04:38:212833 extra_headers, browser_context_, blob_url_loader_factory,
2834 rewrite_virtual_urls));
clamy987a3752018-05-03 17:36:262835 entry->root_node()->frame_entry->set_source_site_instance(
2836 static_cast<SiteInstanceImpl*>(source_site_instance));
2837 entry->root_node()->frame_entry->set_method(method);
2838 }
clamy987a3752018-05-03 17:36:262839
Camille Lamy5193caa2018-10-12 11:59:422840 bool override_user_agent = false;
Rakina Zata Amnie2d31312022-11-18 03:38:452841 if (GetLastCommittedEntry()->GetIsOverridingUserAgent()) {
clamy987a3752018-05-03 17:36:262842 entry->SetIsOverridingUserAgent(true);
Camille Lamy5193caa2018-10-12 11:59:422843 override_user_agent = true;
clamy987a3752018-05-03 17:36:262844 }
2845 // TODO(creis): Set user gesture and intent received timestamp on Android.
2846
2847 // We may not have successfully added the FrameNavigationEntry to |entry|
2848 // above (per https://crbug.com/608402), in which case we create it from
2849 // scratch. This works because we do not depend on |frame_entry| being inside
2850 // |entry| during NavigateToEntry. This will go away when we shortcut this
2851 // further in https://crbug.com/536906.
2852 scoped_refptr<FrameNavigationEntry> frame_entry(entry->GetFrameEntry(node));
2853 if (!frame_entry) {
Patrick Monette50e8bd82019-06-13 22:40:452854 frame_entry = base::MakeRefCounted<FrameNavigationEntry>(
Nate Chapinfbfe5af2021-06-10 17:22:082855 node->unique_name(), -1, -1, "", nullptr,
Nasko Oskov18006bc2018-12-06 02:53:582856 static_cast<SiteInstanceImpl*>(source_site_instance), url,
Arthur Sonzognic686e8f2024-01-11 08:36:372857 std::nullopt /* origin */, referrer, initiator_origin,
W. James MacLean23e90a12022-12-21 04:38:212858 initiator_base_url, std::vector<GURL>(), blink::PageState(), method, -1,
Kunihiko Sakamoto2ae79e62023-05-26 00:34:152859 blob_url_loader_factory, nullptr /* policy_container_policies */,
Domenic Denicolacc094fb2022-03-16 23:40:572860 false /* protect_url_in_navigation_api */);
clamy987a3752018-05-03 17:36:262861 }
2862
Camille Lamy5193caa2018-10-12 11:59:422863 LoadURLParams params(url);
Chris Hamilton83272dc2021-02-23 00:24:022864 params.initiator_frame_token = base::OptionalFromPtr(initiator_frame_token);
Antonio Sartori9a82f6f32020-12-14 09:22:452865 params.initiator_process_id = initiator_process_id;
Nasko Oskov93e7c55c2018-12-19 01:59:292866 params.initiator_origin = initiator_origin;
W. James MacLean23e90a12022-12-21 04:38:212867 params.initiator_base_url = initiator_base_url;
Camille Lamy5193caa2018-10-12 11:59:422868 params.source_site_instance = source_site_instance;
2869 params.load_type = method == "POST" ? LOAD_TYPE_HTTP_POST : LOAD_TYPE_DEFAULT;
2870 params.transition_type = page_transition;
Dominic Farolino226226af2019-06-25 00:58:032871 params.frame_tree_node_id = node->frame_tree_node_id();
Camille Lamy5193caa2018-10-12 11:59:422872 params.referrer = referrer;
2873 /* params.redirect_chain: skip */
2874 params.extra_headers = extra_headers;
2875 params.is_renderer_initiated = is_renderer_initiated;
2876 params.override_user_agent = UA_OVERRIDE_INHERIT;
2877 /* params.base_url_for_data_url: skip */
Shu Yang112ad492024-07-25 17:11:542878 /* params.virtual_url_for_special_cases: skip */
Camille Lamy5193caa2018-10-12 11:59:422879 /* params.data_url_as_string: skip */
2880 params.post_data = post_body;
2881 params.can_load_local_resources = false;
Kevin McNeee60e76b2019-11-27 20:01:582882 /* params.should_replace_current_entry: skip */
Camille Lamy5193caa2018-10-12 11:59:422883 /* params.frame_name: skip */
2884 // TODO(clamy): See if user gesture should be propagated to this function.
2885 params.has_user_gesture = false;
2886 params.should_clear_history_list = false;
2887 params.started_from_context_menu = false;
2888 /* params.navigation_ui_data: skip */
2889 /* params.input_start: skip */
Minggang Wangf59db47b2021-06-16 01:56:222890 params.was_activated = blink::mojom::WasActivatedOption::kUnknown;
Robert Ogden011a8082019-01-23 19:04:542891 /* params.reload_type: skip */
John Delaney50425f82020-04-07 16:26:212892 params.impression = impression;
Antonio Sartori6984c742021-08-26 08:03:412893 params.download_policy = std::move(download_policy);
jongdeok.kim5de823b32022-06-14 04:37:502894 params.is_form_submission = is_form_submission;
Yao Xiao720ef9d62022-12-09 05:18:292895 params.initiator_activation_and_ad_status =
2896 initiator_activation_and_ad_status;
Kevin McNee6455638a2024-06-27 22:05:032897 params.has_rel_opener = has_rel_opener;
Camille Lamy5193caa2018-10-12 11:59:422898
2899 std::unique_ptr<NavigationRequest> request =
2900 CreateNavigationRequestFromLoadParams(
Dominic Farolino226226af2019-06-25 00:58:032901 node, params, override_user_agent, should_replace_current_entry,
Antonio Sartori2f763d9d2021-04-21 10:04:142902 false /* has_user_gesture */, std::move(source_location),
Tsuyoshi Horo167ca6432022-03-09 05:16:392903 ReloadType::NONE, entry.get(), frame_entry.get(),
Garrett Tanzer405f3402022-07-21 20:12:492904 navigation_start_time, is_embedder_initiated_fenced_frame_navigation,
Camillia Smith Barnes6a643962023-03-03 00:28:582905 is_unfenced_top_navigation, is_container_initiated,
W. James MacLean443ef3e2024-07-16 13:42:342906 storage_access_api_status, embedder_shared_storage_context);
clamyea99ea12018-05-28 13:54:232907
2908 if (!request)
2909 return;
2910
Garrett Tanzerbb8db412022-09-27 21:59:462911 // Force the navigation to take place in a new browsing instance.
2912 // This is used by _unfencedTop in fenced frames to ensure that navigations
2913 // leaving the fenced context create a new browsing instance.
2914 if (force_new_browsing_instance) {
2915 request->coop_status().ForceBrowsingInstanceSwap();
2916 }
2917
Arthur Hemery948742762019-09-18 10:06:242918 // At this stage we are proceeding with this navigation. If this was renderer
2919 // initiated with user gesture, we need to make sure we clear up potential
2920 // remains of a cancelled browser initiated navigation to avoid URL spoofs.
2921 DiscardNonCommittedEntries();
2922
Lukasz Anforowicz9ee83c272020-12-01 20:14:052923 node->navigator().Navigate(std::move(request), ReloadType::NONE);
clamy987a3752018-05-03 17:36:262924}
2925
[email protected]d1198fd2012-08-13 22:50:192926void NavigationControllerImpl::SetSessionStorageNamespace(
Alex Moshchuk8015afcf2022-01-31 22:59:252927 const StoragePartitionConfig& partition_config,
[email protected]8ff00d72012-10-23 19:12:212928 SessionStorageNamespace* session_storage_namespace) {
[email protected]d1198fd2012-08-13 22:50:192929 if (!session_storage_namespace)
2930 return;
2931
2932 // We can't overwrite an existing SessionStorage without violating spec.
2933 // Attempts to do so may give a tab access to another tab's session storage
2934 // so die hard on an error.
Aran Gilman37d11632019-10-08 23:07:152935 bool successful_insert =
2936 session_storage_namespace_map_
Alex Moshchuk8015afcf2022-01-31 22:59:252937 .insert(std::make_pair(partition_config,
Aaron Colwellf3b316e2021-03-11 20:17:052938 static_cast<SessionStorageNamespaceImpl*>(
2939 session_storage_namespace)))
[email protected]fdac6ade2013-07-20 01:06:302940 .second;
2941 CHECK(successful_insert) << "Cannot replace existing SessionStorageNamespace";
[email protected]d1198fd2012-08-13 22:50:192942}
2943
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572944bool NavigationControllerImpl::IsUnmodifiedBlankTab() {
Rakina Zata Amnie2d31312022-11-18 03:38:452945 return IsInitialNavigation() && GetLastCommittedEntry()->IsInitialEntry() &&
Ali Hijazid87307d2022-11-07 20:15:032946 !frame_tree_->has_accessed_initial_main_document();
[email protected]aa62afd2014-04-22 19:22:462947}
2948
Aran Gilman37d11632019-10-08 23:07:152949SessionStorageNamespace* NavigationControllerImpl::GetSessionStorageNamespace(
Alex Moshchuk8015afcf2022-01-31 22:59:252950 const StoragePartitionConfig& partition_config) {
[email protected]fdac6ade2013-07-20 01:06:302951 StoragePartition* partition =
Lukasz Anforowiczb9a969a2021-04-29 15:26:252952 browser_context_->GetStoragePartition(partition_config);
michaelnbacbcbd2016-02-09 00:32:032953 DOMStorageContextWrapper* context_wrapper =
2954 static_cast<DOMStorageContextWrapper*>(partition->GetDOMStorageContext());
2955
2956 SessionStorageNamespaceMap::const_iterator it =
Alex Moshchuk8015afcf2022-01-31 22:59:252957 session_storage_namespace_map_.find(partition_config);
michaelnbacbcbd2016-02-09 00:32:032958 if (it != session_storage_namespace_map_.end()) {
2959 // Ensure that this namespace actually belongs to this partition.
Aran Gilman37d11632019-10-08 23:07:152960 DCHECK(static_cast<SessionStorageNamespaceImpl*>(it->second.get())
2961 ->IsFromContext(context_wrapper));
Aaron Colwellb731a0ae2021-03-19 19:14:472962
michaelnbacbcbd2016-02-09 00:32:032963 return it->second.get();
2964 }
2965
2966 // Create one if no one has accessed session storage for this partition yet.
Daniel Murphy31bbb8b12018-02-07 21:44:102967 scoped_refptr<SessionStorageNamespaceImpl> session_storage_namespace =
2968 SessionStorageNamespaceImpl::Create(context_wrapper);
2969 SessionStorageNamespaceImpl* session_storage_namespace_ptr =
2970 session_storage_namespace.get();
Alex Moshchuk8015afcf2022-01-31 22:59:252971 session_storage_namespace_map_[partition_config] =
Daniel Murphy31bbb8b12018-02-07 21:44:102972 std::move(session_storage_namespace);
[email protected]fdac6ade2013-07-20 01:06:302973
Daniel Murphy31bbb8b12018-02-07 21:44:102974 return session_storage_namespace_ptr;
[email protected]fdac6ade2013-07-20 01:06:302975}
2976
2977SessionStorageNamespace*
2978NavigationControllerImpl::GetDefaultSessionStorageNamespace() {
Alex Moshchuk8015afcf2022-01-31 22:59:252979 return GetSessionStorageNamespace(
2980 StoragePartitionConfig::CreateDefault(GetBrowserContext()));
[email protected]fdac6ade2013-07-20 01:06:302981}
2982
2983const SessionStorageNamespaceMap&
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572984NavigationControllerImpl::GetSessionStorageNamespaceMap() {
[email protected]fdac6ade2013-07-20 01:06:302985 return session_storage_namespace_map_;
[email protected]a26023822011-12-29 00:23:552986}
[email protected]d202a7c2012-01-04 07:53:472987
Lucas Furukawa Gadani5553a1582019-01-08 18:55:572988bool NavigationControllerImpl::NeedsReload() {
[email protected]71fde352011-12-29 03:29:562989 return needs_reload_;
2990}
[email protected]a26023822011-12-29 00:23:552991
[email protected]46bb5e9c2013-10-03 22:16:472992void NavigationControllerImpl::SetNeedsReload() {
Alex Moshchuk7b4f0652019-05-30 18:54:412993 SetNeedsReload(NeedsReloadType::kRequestedByClient);
2994}
2995
2996void NavigationControllerImpl::SetNeedsReload(NeedsReloadType type) {
[email protected]46bb5e9c2013-10-03 22:16:472997 needs_reload_ = true;
Alex Moshchuk7b4f0652019-05-30 18:54:412998 needs_reload_type_ = type;
jaekyunc8cefa82015-01-09 20:14:542999
3000 if (last_committed_entry_index_ != -1) {
3001 entries_[last_committed_entry_index_]->SetTransitionType(
3002 ui::PAGE_TRANSITION_RELOAD);
3003 }
[email protected]46bb5e9c2013-10-03 22:16:473004}
3005
[email protected]d202a7c2012-01-04 07:53:473006void NavigationControllerImpl::RemoveEntryAtIndexInternal(int index) {
Kevin McNee05164772019-09-03 17:24:573007 DCHECK_LT(index, GetEntryCount());
3008 DCHECK_NE(index, last_committed_entry_index_);
[email protected]43032342011-03-21 14:10:313009 DiscardNonCommittedEntries();
3010
Nate Chapin9eb16be72022-09-23 22:54:313011 RemovedEntriesTracker tracker(weak_factory_.GetSafeRef());
[email protected]43032342011-03-21 14:10:313012 entries_.erase(entries_.begin() + index);
[email protected]6a13a6c2011-12-20 21:47:123013 if (last_committed_entry_index_ > index)
[email protected]43032342011-03-21 14:10:313014 last_committed_entry_index_--;
3015}
3016
Lucas Furukawa Gadani5553a1582019-01-08 18:55:573017NavigationEntryImpl* NavigationControllerImpl::GetPendingEntry() {
arthursonzogni5c4c202d2017-04-25 23:41:273018 // If there is no pending_entry_, there should be no pending_entry_index_.
3019 DCHECK(pending_entry_ || pending_entry_index_ == -1);
3020
3021 // If there is a pending_entry_index_, then pending_entry_ must be the entry
Carlos IL42b416592019-10-07 23:10:363022 // at that index. An exception is while a reload of a post commit error page
3023 // is ongoing; in that case pending entry will point to the entry replaced
3024 // by the error.
arthursonzogni5c4c202d2017-04-25 23:41:273025 DCHECK(pending_entry_index_ == -1 ||
Carlos IL42b416592019-10-07 23:10:363026 pending_entry_ == GetEntryAtIndex(pending_entry_index_) ||
3027 pending_entry_ == entry_replaced_by_post_commit_error_.get());
arthursonzogni5c4c202d2017-04-25 23:41:273028
[email protected]022af742011-12-28 18:37:253029 return pending_entry_;
3030}
3031
Lucas Furukawa Gadani5553a1582019-01-08 18:55:573032int NavigationControllerImpl::GetPendingEntryIndex() {
arthursonzogni5c4c202d2017-04-25 23:41:273033 // The pending entry index must always be less than the number of entries.
arthursonzogni5c4c202d2017-04-25 23:41:273034 DCHECK_LT(pending_entry_index_, GetEntryCount());
[email protected]a26023822011-12-29 00:23:553035 return pending_entry_index_;
3036}
3037
avi25764702015-06-23 15:43:373038void NavigationControllerImpl::InsertOrReplaceEntry(
dcheng9bfa5162016-04-09 01:00:573039 std::unique_ptr<NavigationEntryImpl> entry,
Carlos IL42b416592019-10-07 23:10:363040 bool replace,
Dave Tapuska87696ae2021-11-18 18:48:313041 bool was_post_commit_error,
Rakina Zata Amnia4e27222021-12-22 01:05:003042 bool in_fenced_frame_tree,
3043 LoadCommittedDetails* commit_details) {
Dave Tapuska87696ae2021-11-18 18:48:313044 // Fenced frame trees should always have `ui::PAGE_TRANSITION_AUTO_SUBFRAME`
3045 // set because:
3046 // 1) They don't influence the history of the outer page.
3047 // 2) They are always replace only navigation (there is always only one entry
3048 // in their history stack).
3049 // 3) Are not top level navigations and appear similar to iframes.
3050 // Navigations of the fenced frame might create a new NavigationEntry, which
3051 // will call this function. Non fenced frame navigations will never have
3052 // `ui::PAGE_TRANSITION_AUTO_SUBFRAME` because they won't call
3053 // InsertOrReplaceEntry.
3054 DCHECK_EQ(in_fenced_frame_tree,
3055 ui::PageTransitionCoreTypeIs(entry->GetTransitionType(),
3056 ui::PAGE_TRANSITION_AUTO_SUBFRAME));
[email protected]765b35502008-08-21 00:51:203057
avi5cad4912015-06-19 05:25:443058 // If the pending_entry_index_ is -1, the navigation was to a new page, and we
3059 // need to keep continuity with the pending entry, so copy the pending entry's
3060 // unique ID to the committed entry. If the pending_entry_index_ isn't -1,
3061 // then the renderer navigated on its own, independent of the pending entry,
3062 // so don't copy anything.
3063 if (pending_entry_ && pending_entry_index_ == -1)
3064 entry->set_unique_id(pending_entry_->GetUniqueID());
[email protected]765b35502008-08-21 00:51:203065
Rakina Zata Amnia4e27222021-12-22 01:05:003066 DiscardNonCommittedEntriesWithCommitDetails(commit_details);
[email protected]765b35502008-08-21 00:51:203067
creisee17e932015-07-17 17:56:223068 // When replacing, don't prune the forward history.
Rakina Zata Amnie2d31312022-11-18 03:38:453069 if (replace || was_post_commit_error) {
Mikel Astizba9cf2fd2017-12-17 10:38:103070 CopyReplacedNavigationEntryDataIfPreviouslyEmpty(
Lucas Furukawa Gadani5553a1582019-01-08 18:55:573071 entries_[last_committed_entry_index_].get(), entry.get());
Carlos IL42b416592019-10-07 23:10:363072 // If the new entry is a post-commit error page, we store the current last
3073 // committed entry to the side so that we can put it back when navigating
3074 // away from the error.
3075 if (was_post_commit_error) {
3076 DCHECK(!entry_replaced_by_post_commit_error_);
3077 entry_replaced_by_post_commit_error_ =
3078 std::move(entries_[last_committed_entry_index_]);
3079 }
dcheng36b6aec92015-12-26 06:16:363080 entries_[last_committed_entry_index_] = std::move(entry);
creisee17e932015-07-17 17:56:223081 return;
3082 }
[email protected]765b35502008-08-21 00:51:203083
creis37979a62015-08-04 19:48:183084 // We shouldn't see replace == true when there's no committed entries.
3085 DCHECK(!replace);
3086
Michael Thiessen9b14d512019-09-23 21:19:473087 PruneForwardEntries();
[email protected]765b35502008-08-21 00:51:203088
Shivani Sharmad8c8d652019-02-13 17:27:573089 PruneOldestSkippableEntryIfFull();
[email protected]765b35502008-08-21 00:51:203090
dcheng36b6aec92015-12-26 06:16:363091 entries_.push_back(std::move(entry));
[email protected]765b35502008-08-21 00:51:203092 last_committed_entry_index_ = static_cast<int>(entries_.size()) - 1;
initial.commit09911bf2008-07-26 23:55:293093}
3094
Shivani Sharmad8c8d652019-02-13 17:27:573095void NavigationControllerImpl::PruneOldestSkippableEntryIfFull() {
Shivani Sharma2d5b4b6b2019-01-08 16:07:163096 if (entries_.size() < max_entry_count())
3097 return;
3098
3099 DCHECK_EQ(max_entry_count(), entries_.size());
3100 DCHECK_GT(last_committed_entry_index_, 0);
Shivani Sharmad8c8d652019-02-13 17:27:573101 CHECK_EQ(pending_entry_index_, -1);
3102
3103 int index = 0;
Elly Fong-Jonesccc6d1f2021-06-14 18:32:423104 // Retrieve the oldest skippable entry.
3105 for (; index < GetEntryCount(); index++) {
3106 if (GetEntryAtIndex(index)->should_skip_on_back_forward_ui())
3107 break;
Shivani Sharmad8c8d652019-02-13 17:27:573108 }
3109
3110 // If there is no skippable entry or if it is the last committed entry then
3111 // fall back to pruning the oldest entry. It is not safe to prune the last
3112 // committed entry.
3113 if (index == GetEntryCount() || index == last_committed_entry_index_)
3114 index = 0;
3115
3116 bool should_succeed = RemoveEntryAtIndex(index);
3117 DCHECK_EQ(true, should_succeed);
3118
3119 NotifyPrunedEntries(this, index, 1);
[email protected]944822b2012-03-02 20:57:253120}
3121
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263122base::WeakPtr<NavigationRequest>
William Liuec04e382024-05-23 18:03:273123NavigationControllerImpl::NavigateToExistingPendingEntry(
Dave Tapuska8bfd84c2019-03-26 20:47:163124 ReloadType reload_type,
Nate Chapinbf682fa32022-09-26 22:41:203125 RenderFrameHostImpl* initiator_rfh,
Arthur Sonzognic686e8f2024-01-11 08:36:373126 std::optional<blink::scheduler::TaskAttributionId>
Yoav Weiss8c573952022-11-17 17:35:133127 soft_navigation_heuristics_task_id,
Nate Chapinbf682fa32022-09-26 22:41:203128 const std::string* navigation_api_key) {
Alexander Timin3a92df72019-09-20 11:59:503129 TRACE_EVENT0("navigation",
3130 "NavigationControllerImpl::NavigateToExistingPendingEntry");
arthursonzogni5c4c202d2017-04-25 23:41:273131 DCHECK(pending_entry_);
clamy3cb9bea92018-07-10 12:42:023132 DCHECK(IsInitialNavigation() || pending_entry_index_ != -1);
Carlos IL42b416592019-10-07 23:10:363133 if (pending_entry_index_ != -1) {
3134 // The pending entry may not be in entries_ if a post-commit error page is
3135 // showing.
3136 DCHECK(pending_entry_ == entries_[pending_entry_index_].get() ||
3137 pending_entry_ == entry_replaced_by_post_commit_error_.get());
3138 }
Gyuyoung Kim107c2a02021-04-13 01:49:303139 DCHECK(!blink::IsRendererDebugURL(pending_entry_->GetURL()));
Alex Moshchuk3a4e77a2020-05-29 21:32:573140 bool is_forced_reload = needs_reload_;
[email protected]72097fd02010-01-21 23:36:013141 needs_reload_ = false;
Ali Hijazid87307d2022-11-07 20:15:033142 FrameTreeNode* root = frame_tree_->root();
Arthur Sonzogni620cec62018-12-13 13:08:573143 int nav_entry_id = pending_entry_->GetUniqueID();
Yoav Weiss8c573952022-11-17 17:35:133144 // Only pass down the soft_navigation_heuristics_task_id when the initiator is
3145 // the same as the top level frame being navigated.
3146 if (root->current_frame_host() != initiator_rfh) {
Arthur Sonzognic686e8f2024-01-11 08:36:373147 soft_navigation_heuristics_task_id = std::nullopt;
Yoav Weiss8c573952022-11-17 17:35:133148 }
Arthur Sonzogni620cec62018-12-13 13:08:573149
[email protected]83c2e232011-10-07 21:36:463150 // If we were navigating to a slow-to-commit page, and the user performs
3151 // a session history navigation to the last committed page, RenderViewHost
3152 // will force the throbber to start, but WebKit will essentially ignore the
3153 // navigation, and won't send a message to stop the throbber. To prevent this
3154 // from happening, we drop the navigation here and stop the slow-to-commit
3155 // page from loading (which would normally happen during the navigation).
clamy3cb9bea92018-07-10 12:42:023156 if (pending_entry_index_ == last_committed_entry_index_ &&
Lukasz Anforowicz6b75c0d2020-12-01 22:56:083157 !pending_entry_->IsRestored() &&
arthursonzogni5c4c202d2017-04-25 23:41:273158 pending_entry_->GetTransitionType() & ui::PAGE_TRANSITION_FORWARD_BACK) {
Ali Hijazid87307d2022-11-07 20:15:033159 frame_tree_->StopLoading();
[email protected]6a13a6c2011-12-20 21:47:123160
[email protected]83c2e232011-10-07 21:36:463161 DiscardNonCommittedEntries();
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263162 return nullptr;
[email protected]83c2e232011-10-07 21:36:463163 }
3164
Arthur Sonzognic686e8f2024-01-11 08:36:373165 std::optional<blink::LocalFrameToken> initiator_frame_token;
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333166 int initiator_process_id = ChildProcessHost::kInvalidUniqueID;
3167 if (initiator_rfh) {
3168 initiator_frame_token = initiator_rfh->GetFrameToken();
3169 initiator_process_id = initiator_rfh->GetProcess()->GetID();
3170 DCHECK(initiator_frame_token);
3171 }
3172
creisce0ef3572017-01-26 17:53:083173 // Compare FrameNavigationEntries to see which frames in the tree need to be
3174 // navigated.
clamy3cb9bea92018-07-10 12:42:023175 std::vector<std::unique_ptr<NavigationRequest>> same_document_loads;
3176 std::vector<std::unique_ptr<NavigationRequest>> different_document_loads;
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333177 FindFramesToNavigate(root, reload_type, initiator_frame_token,
3178 initiator_process_id, soft_navigation_heuristics_task_id,
3179 &same_document_loads, &different_document_loads);
creis4e2ecb72015-06-20 00:46:303180
3181 if (same_document_loads.empty() && different_document_loads.empty()) {
Alex Moshchuk3a4e77a2020-05-29 21:32:573182 // We were unable to match any frames to navigate. This can happen if a
3183 // history navigation targets a subframe that no longer exists
3184 // (https://crbug.com/705550). In this case, we need to update the current
3185 // history entry to the pending one but keep the main document loaded. We
3186 // also need to ensure that observers are informed about the updated
3187 // current history entry (e.g., for greying out back/forward buttons), and
3188 // that renderer processes update their history offsets. The easiest way
3189 // to do all that is to schedule a "redundant" same-document navigation in
3190 // the main frame.
3191 //
3192 // Note that we don't want to remove this history entry, as it might still
3193 // be valid later, since a frame that it's targeting may be recreated.
3194 //
3195 // TODO(alexmos, creis): This behavior isn't ideal, as the user would
3196 // need to repeat history navigations until finding the one that works.
3197 // Consider changing this behavior to keep looking for the first valid
3198 // history entry that finds frames to navigate.
clamy3cb9bea92018-07-10 12:42:023199 std::unique_ptr<NavigationRequest> navigation_request =
Camille Lamy5193caa2018-10-12 11:59:423200 CreateNavigationRequestFromEntry(
Lucas Furukawa Gadani5553a1582019-01-08 18:55:573201 root, pending_entry_, pending_entry_->GetFrameEntry(root),
Alex Moshchuk3a4e77a2020-05-29 21:32:573202 ReloadType::NONE /* reload_type */,
3203 true /* is_same_document_history_load */,
Nate Chapin45f620582021-09-30 17:45:433204 false /* is_history_navigation_in_new_child */,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333205 initiator_frame_token, initiator_process_id);
clamy3cb9bea92018-07-10 12:42:023206 if (!navigation_request) {
Alex Moshchuk3a4e77a2020-05-29 21:32:573207 // If this navigation cannot start, delete the pending NavigationEntry.
clamy3cb9bea92018-07-10 12:42:023208 DiscardPendingEntry(false);
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263209 return nullptr;
clamy3cb9bea92018-07-10 12:42:023210 }
Alex Moshchuk3a4e77a2020-05-29 21:32:573211 same_document_loads.push_back(std::move(navigation_request));
3212
3213 // Sanity check that we never take this branch for any kinds of reloads,
3214 // as those should've queued a different-document load in the main frame.
3215 DCHECK(!is_forced_reload);
3216 DCHECK_EQ(reload_type, ReloadType::NONE);
creis4e2ecb72015-06-20 00:46:303217 }
3218
Nate Chapinbf682fa32022-09-26 22:41:203219 // If the initiator is top-navigation sandboxed, then track whether this
Dave Tapuska8bfd84c2019-03-26 20:47:163220 // navigation affects any frame outside the frame's subtree.
Nate Chapinbf682fa32022-09-26 22:41:203221 if (initiator_rfh && initiator_rfh->IsSandboxed(
3222 network::mojom::WebSandboxFlags::kTopNavigation)) {
3223 bool navigates_inside_tree = DoesSandboxNavigationStayWithinSubtree(
3224 initiator_rfh, same_document_loads) &&
3225 DoesSandboxNavigationStayWithinSubtree(
3226 initiator_rfh, different_document_loads);
Dave Tapuska716ed3af2019-09-23 18:45:503227 // Count the navigations as web use counters so we can determine
Dave Tapuska8bfd84c2019-03-26 20:47:163228 // the number of pages that trigger this.
Nate Chapinbf682fa32022-09-26 22:41:203229 GetContentClient()->browser()->LogWebFeatureForCurrentPage(
3230 initiator_rfh,
3231 navigates_inside_tree
3232 ? blink::mojom::WebFeature::kSandboxBackForwardStaysWithinSubtree
3233 : blink::mojom::WebFeature::
3234 kSandboxBackForwardAffectsFramesOutsideSubtree);
Dave Tapuska855c1e12019-08-23 20:45:523235
3236 // If the navigation occurred outside the tree discard it because
3237 // the sandboxed frame didn't have permission to navigate outside
3238 // its tree. If it is possible that the navigation is both inside and
3239 // outside the frame tree and we discard it entirely because we don't
3240 // want to end up in a history state that didn't exist before.
Dominic Farolino057440042022-01-19 18:18:143241 if (!navigates_inside_tree) {
Nate Chapinbf682fa32022-09-26 22:41:203242 // If a |navigation_api_key| was provided, this navigation originated from
3243 // the navigation API. Notify the renderer that the navigation was
3244 // cancelled so the navigation API can fire an error event and reject the
3245 // relevant promise.
3246 if (navigation_api_key) {
3247 initiator_rfh->GetAssociatedLocalFrame()->TraverseCancelled(
3248 *navigation_api_key,
3249 blink::mojom::TraverseCancelledReason::kSandboxViolation);
3250 }
Dave Tapuska855c1e12019-08-23 20:45:523251 DiscardPendingEntry(false);
Rakina Zata Amni58681c62024-06-25 06:32:133252
3253 for (auto& unused_request : same_document_loads) {
3254 unused_request->set_navigation_discard_reason(
3255 NavigationDiscardReason::kNeverStarted);
3256 }
3257 for (auto& unused_request : different_document_loads) {
3258 unused_request->set_navigation_discard_reason(
3259 NavigationDiscardReason::kNeverStarted);
3260 }
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263261 return nullptr;
Dave Tapuska855c1e12019-08-23 20:45:523262 }
Dave Tapuska8bfd84c2019-03-26 20:47:163263 }
3264
Nate Chapin6c43c022023-02-13 23:32:423265 // If it is possible that this traverse may involve a same-document navigation
3266 // in the initiator and there is a Navigation API key involved, then we may
3267 // need to notify the initiator if it fails. (The early returns above either
3268 // do not involve these cases or already notify the initiator.)
3269 // The event only needs to fire for the initiator, and only if the initiator
3270 // itself is performing a same-document navigation (because the event will not
3271 // fire if it navigates cross-document).
3272 if (navigation_api_key) {
3273 for (auto& item : same_document_loads) {
3274 if (item->frame_tree_node() == initiator_rfh->frame_tree_node()) {
3275 item->set_pending_navigation_api_key(*navigation_api_key);
3276 break;
3277 }
3278 }
3279 }
3280
Carlos Caballero539a421c2020-07-06 10:25:573281 // BackForwardCache:
3282 // Navigate immediately if the document is in the BackForwardCache.
Mingyu Lei7584b6b2023-04-13 03:02:563283 if (back_forward_cache_.GetOrEvictEntry(nav_entry_id).has_value()) {
Carlos Caballero539a421c2020-07-06 10:25:573284 TRACE_EVENT0("navigation", "BackForwardCache_CreateNavigationRequest");
3285 DCHECK_EQ(reload_type, ReloadType::NONE);
3286 auto navigation_request = CreateNavigationRequestFromEntry(
3287 root, pending_entry_, pending_entry_->GetFrameEntry(root),
3288 ReloadType::NONE, false /* is_same_document_history_load */,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333289 false /* is_history_navigation_in_new_child */, initiator_frame_token,
3290 initiator_process_id);
William Liuec04e382024-05-23 18:03:273291 base::WeakPtr<NavigationRequest> request = navigation_request->GetWeakPtr();
Lukasz Anforowicz9ee83c272020-12-01 20:14:053292 root->navigator().Navigate(std::move(navigation_request), ReloadType::NONE);
Rakina Zata Amni58681c62024-06-25 06:32:133293
3294 for (auto& unused_request : same_document_loads) {
3295 unused_request->set_navigation_discard_reason(
3296 NavigationDiscardReason::kNeverStarted);
3297 }
3298 for (auto& unused_request : different_document_loads) {
3299 unused_request->set_navigation_discard_reason(
3300 NavigationDiscardReason::kNeverStarted);
3301 }
3302
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263303 return (request && request->IsInPrimaryMainFrame()) ? request : nullptr;
Carlos Caballero539a421c2020-07-06 10:25:573304 }
3305
3306 // History navigation might try to reuse a specific BrowsingInstance, already
3307 // used by a page in the cache. To avoid having two different main frames that
3308 // live in the same BrowsingInstance, evict the all pages with this
3309 // BrowsingInstance from the cache.
3310 //
3311 // For example, take the following scenario:
3312 //
3313 // A1 = Some page on a.com
3314 // A2 = Some other page on a.com
3315 // B3 = An uncacheable page on b.com
3316 //
3317 // Then the following navigations occur:
3318 // A1->A2->B3->A1
3319 // On the navigation from B3 to A1, A2 will remain in the cache (B3 doesn't
3320 // take its place) and A1 will be created in the same BrowsingInstance (and
3321 // SiteInstance), as A2.
3322 //
3323 // If we didn't do anything, both A1 and A2 would remain alive in the same
3324 // BrowsingInstance/SiteInstance, which is unsupported by
3325 // RenderFrameHostManager::CommitPending(). To avoid this conundrum, we evict
3326 // A2 from the cache.
3327 if (pending_entry_->site_instance()) {
3328 back_forward_cache_.EvictFramesInRelatedSiteInstances(
3329 pending_entry_->site_instance());
3330 }
3331
Rakina Zata Amnid605d462022-06-01 10:17:033332 SCOPED_CRASH_KEY_BOOL("nav_reentrancy", "pending_entry_restored",
3333 pending_entry_ && pending_entry_->IsRestored());
3334 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy", "pending_entry_id",
3335 pending_entry_ ? pending_entry_->GetUniqueID() : -1);
3336 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy", "pending_entry_index",
3337 pending_entry_index_);
3338 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy", "last_committed_index",
3339 last_committed_entry_index_);
3340 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy", "entries_size", entries_.size());
3341 SCOPED_CRASH_KEY_BOOL("nav_reentrancy", "pending_entry_initial",
3342 pending_entry_ && pending_entry_->IsInitialEntry());
3343 SCOPED_CRASH_KEY_BOOL(
3344 "nav_reentrancy", "pending_entry_initial2",
3345 pending_entry_ &&
3346 pending_entry_->IsInitialEntryNotForSynchronousAboutBlank());
3347 SCOPED_CRASH_KEY_BOOL("nav_reentrancy", "is_initial_nav",
3348 IsInitialNavigation());
3349 SCOPED_CRASH_KEY_BOOL("nav_reentrancy", "is_initial_blank_nav",
3350 IsInitialBlankNavigation());
3351 SCOPED_CRASH_KEY_BOOL("nav_reentrancy", "is_forced_reload", is_forced_reload);
3352 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy", "pending_reload_type",
3353 (int)pending_reload_);
3354
clamy3cb9bea92018-07-10 12:42:023355 // This call does not support re-entrancy. See http://crbug.com/347742.
3356 CHECK(!in_navigate_to_pending_entry_);
3357 in_navigate_to_pending_entry_ = true;
creis4e2ecb72015-06-20 00:46:303358
Rakina Zata Amnid605d462022-06-01 10:17:033359 // If the navigation-reentrancy is caused by calling
3360 // NavigateToExistingPendingEntry twice, this will note the previous call's
3361 // pending entry's ID.
3362 SCOPED_CRASH_KEY_NUMBER("nav_reentrancy", "prev_pending_entry_id",
3363 pending_entry_ ? pending_entry_->GetUniqueID() : -1);
3364
arthursonzogni66f711c2019-10-08 14:40:363365 // It is not possible to delete the pending NavigationEntry while navigating
3366 // to it. Grab a reference to delay potential deletion until the end of this
3367 // function.
3368 std::unique_ptr<PendingEntryRef> pending_entry_ref = ReferencePendingEntry();
3369
Nate Chapin154b14b2023-02-17 18:28:163370 // If there is a main-frame same-document history navigation, we may defer
3371 // the subframe history navigations in order to give JS in the main frame the
3372 // opportunity to cancel the entire traverse via the navigate event. In that
3373 // case, we need to stash the main frame request's navigation token on the
3374 // subframes, so they can look up the main frame request and defer themselves
3375 // until it completes.
3376 if (!same_document_loads.empty() &&
3377 same_document_loads.at(0)->frame_tree_node()->IsMainFrame()) {
3378 NavigationRequest* main_frame_request = same_document_loads.at(0).get();
3379 // The token will only be returned in cases where deferring the navigation
3380 // is necessary.
3381 if (auto main_frame_same_document_token =
3382 main_frame_request->GetNavigationTokenForDeferringSubframes()) {
3383 for (auto& item : same_document_loads) {
3384 if (item.get() != main_frame_request) {
3385 item->set_main_frame_same_document_history_token(
3386 main_frame_same_document_token);
3387 }
3388 }
3389 for (auto& item : different_document_loads) {
3390 item->set_main_frame_same_document_history_token(
3391 main_frame_same_document_token);
3392 }
3393 }
3394 }
3395
William Liu122754942024-01-18 22:34:393396 if (!initiator_rfh) {
3397 // A browser-initiated navigation won't have a `initiator_rfh`.
3398 CountBrowserInitiatedMainframeAndSubframeHistoryNavigaions(
3399 different_document_loads, same_document_loads);
3400 }
3401
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263402 base::WeakPtr<NavigationRequest> primary_main_frame_request;
creis4e2ecb72015-06-20 00:46:303403 // Send all the same document frame loads before the different document loads.
clamy3cb9bea92018-07-10 12:42:023404 for (auto& item : same_document_loads) {
3405 FrameTreeNode* frame = item->frame_tree_node();
William Liuec04e382024-05-23 18:03:273406 // The request could be destroyed before `navigator().Navigate()` returns.
3407 base::WeakPtr<NavigationRequest> request = item->GetWeakPtr();
Lukasz Anforowicz9ee83c272020-12-01 20:14:053408 frame->navigator().Navigate(std::move(item), reload_type);
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263409 if (request && request->IsInPrimaryMainFrame()) {
3410 // Only one primary main frame `NavigationRequest` should occur.
3411 CHECK(!primary_main_frame_request);
3412 primary_main_frame_request = request;
William Liuec04e382024-05-23 18:03:273413 }
creis4e2ecb72015-06-20 00:46:303414 }
clamy3cb9bea92018-07-10 12:42:023415 for (auto& item : different_document_loads) {
3416 FrameTreeNode* frame = item->frame_tree_node();
William Liuec04e382024-05-23 18:03:273417 base::WeakPtr<NavigationRequest> request = item->GetWeakPtr();
Lukasz Anforowicz9ee83c272020-12-01 20:14:053418 frame->navigator().Navigate(std::move(item), reload_type);
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263419 if (request && request->IsInPrimaryMainFrame()) {
3420 // Only one primary main frame `NavigationRequest` should occur.
3421 CHECK(!primary_main_frame_request);
3422 primary_main_frame_request = request;
William Liuec04e382024-05-23 18:03:273423 }
creis4e2ecb72015-06-20 00:46:303424 }
clamy3cb9bea92018-07-10 12:42:023425
3426 in_navigate_to_pending_entry_ = false;
William Liuec04e382024-05-23 18:03:273427
Michael van Ouwerkerkcd2f19b2024-08-07 12:37:263428 return primary_main_frame_request;
creis4e2ecb72015-06-20 00:46:303429}
3430
Alex Moshchuk3a4e77a2020-05-29 21:32:573431NavigationControllerImpl::HistoryNavigationAction
3432NavigationControllerImpl::DetermineActionForHistoryNavigation(
creis4e2ecb72015-06-20 00:46:303433 FrameTreeNode* frame,
Alex Moshchuk3a4e77a2020-05-29 21:32:573434 ReloadType reload_type) {
Sreeja Kamishetty8eacabb2021-03-09 11:45:423435 RenderFrameHostImpl* render_frame_host = frame->current_frame_host();
Sreeja Kamishettydb8e2892021-03-10 09:30:583436 // Only active and prerendered documents are allowed to navigate in their
3437 // frame.
Sreeja Kamishetty8eacabb2021-03-09 11:45:423438 if (render_frame_host->lifecycle_state() !=
Sreeja Kamishetty299329ad2021-03-25 14:06:013439 RenderFrameHostImpl::LifecycleStateImpl::kPrerendering) {
Sreeja Kamishettydb8e2892021-03-10 09:30:583440 // - If the document is in pending deletion, the browser already committed
3441 // to destroying this RenderFrameHost. See https://crbug.com/930278.
3442 // - If the document is in back-forward cache, it's not allowed to navigate
3443 // as it should remain frozen. Ignore the request and evict the document
3444 // from back-forward cache.
Sreeja Kamishetty8eacabb2021-03-09 11:45:423445 //
Sreeja Kamishettydb8e2892021-03-10 09:30:583446 // If the document is inactive, there's no need to recurse into subframes,
Sreeja Kamishetty8eacabb2021-03-09 11:45:423447 // which should all be inactive as well.
Fergal Daly1336ac642021-09-14 15:13:113448 if (frame->current_frame_host()->IsInactiveAndDisallowActivation(
3449 DisallowActivationReasonId::kDetermineActionForHistoryNavigation)) {
Sreeja Kamishetty8eacabb2021-03-09 11:45:423450 return HistoryNavigationAction::kStopLooking;
Fergal Daly1336ac642021-09-14 15:13:113451 }
Sreeja Kamishetty8eacabb2021-03-09 11:45:423452 }
arthursonzogni03f76152019-02-12 10:35:203453
Alex Moshchuk3a4e77a2020-05-29 21:32:573454 // Reloads should result in a different-document load. Note that reloads may
3455 // also happen via the |needs_reload_| mechanism where the reload_type is
3456 // NONE, so detect this by comparing whether we're going to the same
3457 // entry that we're currently on. Similarly to above, only main frames
3458 // should reach this. Note that subframes support reloads, but that's done
3459 // via a different path that doesn't involve FindFramesToNavigate (see
3460 // RenderFrameHost::Reload()).
3461 if (reload_type != ReloadType::NONE ||
3462 pending_entry_index_ == last_committed_entry_index_) {
3463 DCHECK(frame->IsMainFrame());
3464 return HistoryNavigationAction::kDifferentDocument;
3465 }
3466
Alex Moshchuk47d1a4bd2020-06-01 22:15:343467 // If there is no new FrameNavigationEntry for the frame, ignore the
3468 // load. For example, this may happen when going back to an entry before a
3469 // frame was created. Suppose we commit a same-document navigation that also
3470 // results in adding a new subframe somewhere in the tree. If we go back,
3471 // the new subframe will be missing a FrameNavigationEntry in the previous
3472 // NavigationEntry, but we shouldn't delete or change what's loaded in
3473 // it.
3474 //
Alex Moshchuke65c39272020-06-03 17:55:373475 // Note that in this case, there is no need to keep looking for navigations
3476 // in subframes, which would be missing FrameNavigationEntries as well.
3477 //
Alex Moshchuk47d1a4bd2020-06-01 22:15:343478 // It's important to check this before checking |old_item| below, since both
3479 // might be null, and in that case we still shouldn't change what's loaded in
3480 // this frame. Note that scheduling any loads assumes that |new_item| is
3481 // non-null. See https://crbug.com/1088354.
3482 FrameNavigationEntry* new_item = pending_entry_->GetFrameEntry(frame);
3483 if (!new_item)
Alex Moshchuke65c39272020-06-03 17:55:373484 return HistoryNavigationAction::kStopLooking;
Alex Moshchuk47d1a4bd2020-06-01 22:15:343485
Charlie Reisa474fb62022-03-17 02:31:363486 // Use the RenderFrameHost's last committed FrameNavigationEntry to identify
3487 // which history item it is currently on, since this may be different than the
3488 // FrameNavigationEntry for the frame in the last committed NavigationEntry
3489 // (e.g., if a history navigation is targeting multiple frames and only some
3490 // have committed so far).
creis4e2ecb72015-06-20 00:46:303491 FrameNavigationEntry* old_item =
Charlie Reisa474fb62022-03-17 02:31:363492 frame->current_frame_host()->last_committed_frame_entry();
3493 if (!old_item) {
3494 // In cases where the RenderFrameHost does not have a FrameNavigationEntry,
3495 // fall back to the last committed NavigationEntry's record for this frame.
3496 // This may happen in cases like the initial state of the RenderFrameHost.
Alison Gale770f3fc2024-04-27 00:39:583497 // TODO(crbug.com/40217743): Ensure the RenderFrameHost always has an
Charlie Reisa474fb62022-03-17 02:31:363498 // accurate FrameNavigationEntry and eliminate this case.
3499 old_item = GetLastCommittedEntry()->GetFrameEntry(frame);
3500 }
3501 // If neither approach finds a FrameNavigationEntry, schedule a
3502 // different-document load.
Alison Gale770f3fc2024-04-27 00:39:583503 // TODO(crbug.com/40467594): Remove this case.
Alex Moshchuk3a4e77a2020-05-29 21:32:573504 if (!old_item)
3505 return HistoryNavigationAction::kDifferentDocument;
3506
Alex Moshchuk3a4e77a2020-05-29 21:32:573507 // If the new item is not in the same SiteInstance, schedule a
3508 // different-document load. Newly restored items may not have a SiteInstance
3509 // yet, in which case it will be assigned on first commit.
3510 if (new_item->site_instance() &&
3511 new_item->site_instance() != old_item->site_instance())
3512 return HistoryNavigationAction::kDifferentDocument;
3513
3514 // Schedule a different-document load if the current RenderFrameHost is not
danakj25c436d2021-04-01 16:35:313515 // live. This case can happen for Ctrl+Back or after a renderer crash. Note
3516 // that we do this even if the history navigation would not be modifying this
3517 // frame were it live.
3518 if (!frame->current_frame_host()->IsRenderFrameLive())
Alex Moshchuk3a4e77a2020-05-29 21:32:573519 return HistoryNavigationAction::kDifferentDocument;
3520
3521 if (new_item->item_sequence_number() != old_item->item_sequence_number()) {
danakj25c436d2021-04-01 16:35:313522 // Starting a navigation after a crash early-promotes the speculative
3523 // RenderFrameHost. Then we have a RenderFrameHost with no document in it
3524 // committed yet, so we can not possibly perform a same-document history
3525 // navigation. The frame would need to be reloaded with a cross-document
3526 // navigation.
3527 if (!frame->current_frame_host()->has_committed_any_navigation())
3528 return HistoryNavigationAction::kDifferentDocument;
3529
creis54131692016-08-12 18:32:253530 // Same document loads happen if the previous item has the same document
danakjb952ef12021-01-14 19:58:493531 // sequence number but different item sequence number.
3532 if (new_item->document_sequence_number() ==
3533 old_item->document_sequence_number()) {
Alex Moshchuk3a4e77a2020-05-29 21:32:573534 return HistoryNavigationAction::kSameDocument;
danakjb952ef12021-01-14 19:58:493535 }
avib48cb312016-05-05 21:35:003536
Alex Moshchuk3a4e77a2020-05-29 21:32:573537 // Otherwise, if both item and document sequence numbers differ, this
3538 // should be a different document load.
3539 return HistoryNavigationAction::kDifferentDocument;
3540 }
3541
3542 // If the item sequence numbers match, there is no need to navigate this
Alex Moshchuke65c39272020-06-03 17:55:373543 // frame. Keep looking for navigations in this frame's children.
Alex Moshchuk3a4e77a2020-05-29 21:32:573544 DCHECK_EQ(new_item->document_sequence_number(),
3545 old_item->document_sequence_number());
Alex Moshchuke65c39272020-06-03 17:55:373546 return HistoryNavigationAction::kKeepLooking;
Alex Moshchuk3a4e77a2020-05-29 21:32:573547}
3548
3549void NavigationControllerImpl::FindFramesToNavigate(
3550 FrameTreeNode* frame,
3551 ReloadType reload_type,
Arthur Sonzognic686e8f2024-01-11 08:36:373552 const std::optional<blink::LocalFrameToken>& initiator_frame_token,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333553 int initiator_process_id,
Arthur Sonzognic686e8f2024-01-11 08:36:373554 std::optional<blink::scheduler::TaskAttributionId>
Yoav Weiss8c573952022-11-17 17:35:133555 soft_navigation_heuristics_task_id,
Alex Moshchuk3a4e77a2020-05-29 21:32:573556 std::vector<std::unique_ptr<NavigationRequest>>* same_document_loads,
3557 std::vector<std::unique_ptr<NavigationRequest>>* different_document_loads) {
3558 DCHECK(pending_entry_);
3559 FrameNavigationEntry* new_item = pending_entry_->GetFrameEntry(frame);
3560
3561 auto action = DetermineActionForHistoryNavigation(frame, reload_type);
3562
3563 if (action == HistoryNavigationAction::kSameDocument) {
3564 std::unique_ptr<NavigationRequest> navigation_request =
3565 CreateNavigationRequestFromEntry(
3566 frame, pending_entry_, new_item, reload_type,
Yoav Weiss8c573952022-11-17 17:35:133567 /*is_same_document_history_load=*/true,
3568 /*is_history_navigation_in_new_child_frame=*/false,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333569 initiator_frame_token, initiator_process_id,
3570 soft_navigation_heuristics_task_id);
Alex Moshchuk3a4e77a2020-05-29 21:32:573571 if (navigation_request) {
3572 // Only add the request if was properly created. It's possible for the
3573 // creation to fail in certain cases, e.g. when the URL is invalid.
3574 same_document_loads->push_back(std::move(navigation_request));
creis4e2ecb72015-06-20 00:46:303575 }
Alex Moshchuk3a4e77a2020-05-29 21:32:573576 } else if (action == HistoryNavigationAction::kDifferentDocument) {
Lei Zhang96031532019-10-10 19:05:473577 std::unique_ptr<NavigationRequest> navigation_request =
3578 CreateNavigationRequestFromEntry(
3579 frame, pending_entry_, new_item, reload_type,
3580 false /* is_same_document_history_load */,
Nate Chapin45f620582021-09-30 17:45:433581 false /* is_history_navigation_in_new_child */,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333582 initiator_frame_token, initiator_process_id);
Lei Zhang96031532019-10-10 19:05:473583 if (navigation_request) {
3584 // Only add the request if was properly created. It's possible for the
3585 // creation to fail in certain cases, e.g. when the URL is invalid.
3586 different_document_loads->push_back(std::move(navigation_request));
3587 }
3588 // For a different document, the subframes will be destroyed, so there's
3589 // no need to consider them.
3590 return;
Alex Moshchuke65c39272020-06-03 17:55:373591 } else if (action == HistoryNavigationAction::kStopLooking) {
3592 return;
creis4e2ecb72015-06-20 00:46:303593 }
3594
Yoav Weiss8c573952022-11-17 17:35:133595 // Do not pass down the soft_navigation_heuristics_task_id to child frames, as
3596 // we currently only support soft navigation heuristics for the top level
3597 // frame.
creis4e2ecb72015-06-20 00:46:303598 for (size_t i = 0; i < frame->child_count(); i++) {
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:333599 FindFramesToNavigate(frame->child_at(i), reload_type, initiator_frame_token,
3600 initiator_process_id,
Arthur Sonzognic686e8f2024-01-11 08:36:373601 /*soft_navigation_heuristics_task_id=*/std::nullopt,
Nate Chapin45f620582021-09-30 17:45:433602 same_document_loads, different_document_loads);
creis4e2ecb72015-06-20 00:46:303603 }
3604}
3605
Harkiran Bolariaba823e42021-05-21 18:30:363606base::WeakPtr<NavigationHandle> NavigationControllerImpl::NavigateWithoutEntry(
clamy21718cc22018-06-13 13:34:243607 const LoadURLParams& params) {
3608 // Find the appropriate FrameTreeNode.
3609 FrameTreeNode* node = nullptr;
3610 if (params.frame_tree_node_id != RenderFrameHost::kNoFrameTreeNodeId ||
3611 !params.frame_name.empty()) {
3612 node = params.frame_tree_node_id != RenderFrameHost::kNoFrameTreeNodeId
Ali Hijazid87307d2022-11-07 20:15:033613 ? frame_tree_->FindByID(params.frame_tree_node_id)
3614 : frame_tree_->FindByName(params.frame_name);
Arthur Sonzognif6785ec2022-12-05 10:11:503615 DCHECK(!node || &node->frame_tree() == &frame_tree());
clamy21718cc22018-06-13 13:34:243616 }
3617
3618 // If no FrameTreeNode was specified, navigate the main frame.
3619 if (!node)
Ali Hijazid87307d2022-11-07 20:15:033620 node = frame_tree_->root();
clamy21718cc22018-06-13 13:34:243621
Camille Lamy5193caa2018-10-12 11:59:423622 // Compute overrides to the LoadURLParams for |override_user_agent|,
3623 // |should_replace_current_entry| and |has_user_gesture| that will be used
3624 // both in the creation of the NavigationEntry and the NavigationRequest.
3625 // Ideally, the LoadURLParams themselves would be updated, but since they are
3626 // passed as a const reference, this is not possible.
3627 // TODO(clamy): When we only create a NavigationRequest, move this to
3628 // CreateNavigationRequestFromLoadURLParams.
3629 bool override_user_agent = ShouldOverrideUserAgent(params.override_user_agent,
3630 GetLastCommittedEntry());
3631
Rakina Zata Amnie2d31312022-11-18 03:38:453632 // An entry replacement must happen if the current browsing context should
3633 // maintain a trivial session history.
shivanigithubf405bf0d2021-11-05 17:58:333634 bool should_replace_current_entry =
3635 (params.should_replace_current_entry ||
Rakina Zata Amnie2d31312022-11-18 03:38:453636 ShouldMaintainTrivialSessionHistory(node));
Camille Lamy5193caa2018-10-12 11:59:423637
clamy21718cc22018-06-13 13:34:243638 // Javascript URLs should not create NavigationEntries. All other navigations
3639 // do, including navigations to chrome renderer debug URLs.
clamy21718cc22018-06-13 13:34:243640 if (!params.url.SchemeIs(url::kJavaScriptScheme)) {
Scott Violet5ae6c42e2020-10-28 02:47:373641 std::unique_ptr<NavigationEntryImpl> entry =
3642 CreateNavigationEntryFromLoadParams(node, params, override_user_agent,
3643 should_replace_current_entry,
3644 params.has_user_gesture);
clamy21718cc22018-06-13 13:34:243645 DiscardPendingEntry(false);
3646 SetPendingEntry(std::move(entry));
3647 }
3648
Tim Judkins59548192023-05-17 17:51:203649 // Renderer-debug URLs are sent to the current renderer process immediately
3650 // for processing and don't need to create a NavigationRequest. Note: this
3651 // includes navigations to JavaScript URLs, which are considered
clamy21718cc22018-06-13 13:34:243652 // renderer-debug URLs.
3653 // Note: we intentionally leave the pending entry in place for renderer debug
3654 // URLs, unlike the cases below where we clear it if the navigation doesn't
3655 // proceed.
Gyuyoung Kim107c2a02021-04-13 01:49:303656 if (blink::IsRendererDebugURL(params.url)) {
Oleg Davydov2cc0167b2019-02-05 14:32:483657 // Renderer-debug URLs won't go through NavigationThrottlers so we have to
3658 // check them explicitly. See bug 913334.
Aaron Colwelle1908d982020-06-26 22:08:153659 if (GetContentClient()->browser()->ShouldBlockRendererDebugURL(
Tim Judkins59548192023-05-17 17:51:203660 params.url, browser_context_, node->current_frame_host())) {
Oleg Davydov2cc0167b2019-02-05 14:32:483661 DiscardPendingEntry(false);
Harkiran Bolariaba823e42021-05-21 18:30:363662 return nullptr;
Oleg Davydov2cc0167b2019-02-05 14:32:483663 }
3664
clamy21718cc22018-06-13 13:34:243665 HandleRendererDebugURL(node, params.url);
Harkiran Bolariaba823e42021-05-21 18:30:363666 return nullptr;
clamy21718cc22018-06-13 13:34:243667 }
3668
Antonio Sartori78a749f2020-11-30 12:03:393669 DCHECK(pending_entry_);
3670
clamy21718cc22018-06-13 13:34:243671 // Convert navigations to the current URL to a reload.
3672 // TODO(clamy): We should be using FrameTreeNode::IsMainFrame here instead of
3673 // relying on the frame tree node id from LoadURLParams. Unfortunately,
3674 // DevTools sometimes issues navigations to main frames that they do not
3675 // expect to see treated as reload, and it only works because they pass a
3676 // FrameTreeNode id in their LoadURLParams. Change this once they no longer do
3677 // that. See https://crbug.com/850926.
Robert Ogden011a8082019-01-23 19:04:543678 ReloadType reload_type = params.reload_type;
3679 if (reload_type == ReloadType::NONE &&
3680 ShouldTreatNavigationAsReload(
Fergal Daly766177d2020-07-07 07:54:043681 node, params.url, pending_entry_->GetVirtualURL(),
clamy21718cc22018-06-13 13:34:243682 params.base_url_for_data_url, params.transition_type,
clamy21718cc22018-06-13 13:34:243683 params.load_type ==
3684 NavigationController::LOAD_TYPE_HTTP_POST /* is_post */,
Hayato Ito7a80db42021-07-05 06:18:543685 should_replace_current_entry, GetLastCommittedEntry())) {
clamy21718cc22018-06-13 13:34:243686 reload_type = ReloadType::NORMAL;
Alexander Timinb70f67382020-12-10 00:03:473687 pending_entry_->set_reload_type(reload_type);
Antonio Sartori78a749f2020-11-30 12:03:393688
3689 // If this is a reload of an existing FrameNavigationEntry and we had a
3690 // policy container for it, then we should copy it into the pending entry,
3691 // so that it is copied to the navigation request in
3692 // CreateNavigationRequestFromLoadParams later.
Rakina Zata Amnie2d31312022-11-18 03:38:453693 FrameNavigationEntry* previous_frame_entry =
3694 GetLastCommittedEntry()->GetFrameEntry(node);
3695 if (previous_frame_entry &&
3696 previous_frame_entry->policy_container_policies()) {
3697 pending_entry_->GetFrameEntry(node)->set_policy_container_policies(
3698 previous_frame_entry->policy_container_policies()->ClonePtr());
Antonio Sartori78a749f2020-11-30 12:03:393699 }
3700 }
3701
3702 // If this navigation is an "Enter-in-omnibox" with the initial about:blank
Rakina Zata Amniafd3c6582021-11-30 06:19:173703 // document, then we should copy the document polices from RenderFrameHost's
3704 // PolicyContainerHost. The NavigationRequest will create a new
3705 // PolicyContainerHost with the document policies from the |pending_entry_|,
3706 // and that PolicyContainerHost will be put in the final RenderFrameHost for
3707 // the navigation. This way, we ensure that we keep enforcing the right
3708 // policies on the initial empty document after the reload.
Rakina Zata Amnie2d31312022-11-18 03:38:453709 if (GetLastCommittedEntry()->IsInitialEntry() && params.url.IsAboutBlank()) {
Antonio Sartori78a749f2020-11-30 12:03:393710 if (node->current_frame_host() &&
3711 node->current_frame_host()->policy_container_host()) {
Titouan Rigoudy6ec70402021-02-02 15:42:193712 pending_entry_->GetFrameEntry(node)->set_policy_container_policies(
Antonio Sartori5d09b30f2021-03-02 09:27:163713 node->current_frame_host()
3714 ->policy_container_host()
3715 ->policies()
Titouan Rigoudy72f892d2022-05-02 18:21:233716 .ClonePtr());
Antonio Sartori78a749f2020-11-30 12:03:393717 }
clamy21718cc22018-06-13 13:34:243718 }
3719
3720 // navigation_ui_data should only be present for main frame navigations.
Ian Vollick1c6dd3e2022-04-13 02:06:263721 DCHECK(node->IsOutermostMainFrame() || !params.navigation_ui_data);
clamy21718cc22018-06-13 13:34:243722
Tsuyoshi Horo167ca6432022-03-09 05:16:393723 // This will be used to set the Navigation Timing API navigationStart
3724 // parameter for browser navigations in new tabs (intents, tabs opened through
3725 // "Open link in new tab"). If the navigation must wait on the current
3726 // RenderFrameHost to execute its BeforeUnload event, the navigation start
3727 // will be updated when the BeforeUnload ack is received.
3728 const auto navigation_start_time = base::TimeTicks::Now();
3729
Camille Lamy5193caa2018-10-12 11:59:423730 std::unique_ptr<NavigationRequest> request =
3731 CreateNavigationRequestFromLoadParams(
3732 node, params, override_user_agent, should_replace_current_entry,
Antonio Sartori2f763d9d2021-04-21 10:04:143733 params.has_user_gesture, network::mojom::SourceLocation::New(),
Tsuyoshi Horo167ca6432022-03-09 05:16:393734 reload_type, pending_entry_, pending_entry_->GetFrameEntry(node),
3735 navigation_start_time);
clamy21718cc22018-06-13 13:34:243736
3737 // If the navigation couldn't start, return immediately and discard the
3738 // pending NavigationEntry.
3739 if (!request) {
3740 DiscardPendingEntry(false);
Harkiran Bolariaba823e42021-05-21 18:30:363741 return nullptr;
clamy21718cc22018-06-13 13:34:243742 }
3743
Camille Lamy5193caa2018-10-12 11:59:423744#if DCHECK_IS_ON()
3745 // Safety check that NavigationRequest and NavigationEntry match.
3746 ValidateRequestMatchesEntry(request.get(), pending_entry_);
3747#endif
3748
clamy21718cc22018-06-13 13:34:243749 // This call does not support re-entrancy. See http://crbug.com/347742.
3750 CHECK(!in_navigate_to_pending_entry_);
3751 in_navigate_to_pending_entry_ = true;
3752
arthursonzogni66f711c2019-10-08 14:40:363753 // It is not possible to delete the pending NavigationEntry while navigating
3754 // to it. Grab a reference to delay potential deletion until the end of this
3755 // function.
3756 std::unique_ptr<PendingEntryRef> pending_entry_ref = ReferencePendingEntry();
3757
Harkiran Bolariaba823e42021-05-21 18:30:363758 base::WeakPtr<NavigationHandle> created_navigation_handle(
3759 request->GetWeakPtr());
Lukasz Anforowicz9ee83c272020-12-01 20:14:053760 node->navigator().Navigate(std::move(request), reload_type);
clamy21718cc22018-06-13 13:34:243761
3762 in_navigate_to_pending_entry_ = false;
Harkiran Bolariaba823e42021-05-21 18:30:363763 return created_navigation_handle;
clamy21718cc22018-06-13 13:34:243764}
3765
clamyea99ea12018-05-28 13:54:233766void NavigationControllerImpl::HandleRendererDebugURL(
3767 FrameTreeNode* frame_tree_node,
3768 const GURL& url) {
3769 if (!frame_tree_node->current_frame_host()->IsRenderFrameLive()) {
clamy21718cc22018-06-13 13:34:243770 // Any renderer-side debug URLs or javascript: URLs should be ignored if
3771 // the renderer process is not live, unless it is the initial navigation
3772 // of the tab.
clamyea99ea12018-05-28 13:54:233773 if (!IsInitialNavigation()) {
3774 DiscardNonCommittedEntries();
3775 return;
3776 }
Fergal Dalyecd3b0202020-06-25 01:57:373777 // The current frame is always a main frame. If IsInitialNavigation() is
3778 // true then there have been no navigations and any frames of this tab must
3779 // be in the same renderer process. If that has crashed then the only frame
3780 // that can be revived is the main frame.
3781 frame_tree_node->render_manager()
3782 ->InitializeMainRenderFrameForImmediateUse();
clamyea99ea12018-05-28 13:54:233783 }
Julie Jeongeun Kim50d124c2022-10-21 13:51:223784
3785 // Several tests expect a load of Chrome Debug URLs to send a DidStopLoading
3786 // notification, so set is loading to true here to properly surface it when
3787 // the renderer process is done handling the URL.
Alison Gale81f4f2c72024-04-22 19:33:313788 // TODO(crbug.com/40199456): Remove the test dependency on this behavior.
Julie Jeongeun Kim50d124c2022-10-21 13:51:223789 if (!url.SchemeIs(url::kJavaScriptScheme)) {
Julie Jeongeun Kim50d124c2022-10-21 13:51:223790 frame_tree_node->current_frame_host()->SetIsLoadingForRendererDebugURL();
Julie Jeongeun Kim50d124c2022-10-21 13:51:223791 }
clamyea99ea12018-05-28 13:54:233792 frame_tree_node->current_frame_host()->HandleRendererDebugURL(url);
3793}
3794
clamy21718cc22018-06-13 13:34:243795std::unique_ptr<NavigationEntryImpl>
3796NavigationControllerImpl::CreateNavigationEntryFromLoadParams(
3797 FrameTreeNode* node,
Camille Lamy5193caa2018-10-12 11:59:423798 const LoadURLParams& params,
3799 bool override_user_agent,
3800 bool should_replace_current_entry,
3801 bool has_user_gesture) {
Marijn Kruisselbrink0c87e6e2018-06-22 22:57:393802 // Browser initiated navigations might not have a blob_url_loader_factory set
3803 // in params even if the navigation is to a blob URL. If that happens, lookup
3804 // the correct url loader factory to use here.
3805 auto blob_url_loader_factory = params.blob_url_loader_factory;
Kinuko Yasuda7d925ea22019-08-01 10:08:483806 if (!blob_url_loader_factory && params.url.SchemeIsBlob()) {
Marijn Kruisselbrink8ffda442020-09-03 18:29:473807 // Resolve the blob URL in the storage partition associated with the target
3808 // frame. This is the storage partition the URL will be loaded in, and only
3809 // URLs that can be resolved by it should be able to access its data.
Marijn Kruisselbrink0c87e6e2018-06-22 22:57:393810 blob_url_loader_factory = ChromeBlobStorageContext::URLLoaderFactoryForUrl(
Marijn Kruisselbrink8ffda442020-09-03 18:29:473811 node->current_frame_host()->GetStoragePartition(), params.url);
Marijn Kruisselbrink0c87e6e2018-06-22 22:57:393812 }
3813
clamy21718cc22018-06-13 13:34:243814 std::unique_ptr<NavigationEntryImpl> entry;
Tommy C. Li03eee77a2019-02-05 02:07:443815 // extra_headers in params are \n separated; navigation entries want \r\n.
3816 std::string extra_headers_crlf;
3817 base::ReplaceChars(params.extra_headers, "\n", "\r\n", &extra_headers_crlf);
clamy21718cc22018-06-13 13:34:243818
3819 // For subframes, create a pending entry with a corresponding frame entry.
3820 if (!node->IsMainFrame()) {
Rakina Zata Amnie2d31312022-11-18 03:38:453821 entry = GetLastCommittedEntry()->Clone();
clamy21718cc22018-06-13 13:34:243822 entry->AddOrUpdateFrameEntry(
Nate Chapinfbfe5af2021-06-10 17:22:083823 node, NavigationEntryImpl::UpdatePolicy::kReplace, -1, -1, "", nullptr,
clamy21718cc22018-06-13 13:34:243824 static_cast<SiteInstanceImpl*>(params.source_site_instance.get()),
Arthur Sonzognic686e8f2024-01-11 08:36:373825 params.url, std::nullopt, params.referrer, params.initiator_origin,
W. James MacLean23e90a12022-12-21 04:38:213826 params.initiator_base_url, params.redirect_chain, blink::PageState(),
3827 "GET", -1, blob_url_loader_factory,
Antonio Sartori78a749f2020-11-30 12:03:393828 // If in NavigateWithoutEntry we later determine that this navigation is
Charlie Reis7e2cb6d2021-01-26 01:27:163829 // a conversion of a new navigation into a reload, we will set the right
3830 // document policies there.
Titouan Rigoudy6ec70402021-02-02 15:42:193831 nullptr /* policy_container_policies */);
clamy21718cc22018-06-13 13:34:243832 } else {
3833 // Otherwise, create a pending entry for the main frame.
Julie Jeongeun Kim5b9aff72022-05-02 02:10:173834 // If `node` is the outermost main frame, it rewrites a virtual url in order
3835 // to adjust the original input url if needed. For inner frames such as
3836 // fenced frames or subframes, they don't rewrite urls as the urls are not
3837 // input urls by users.
3838 bool rewrite_virtual_urls = node->IsOutermostMainFrame();
Sharon Yang242ef822023-05-15 21:07:323839 scoped_refptr<SiteInstance> source_site_instance =
3840 params.source_site_instance;
Arthur Sonzognic686e8f2024-01-11 08:36:373841 std::optional<GURL> source_process_site_url = std::nullopt;
Sharon Yang242ef822023-05-15 21:07:323842 if (source_site_instance && source_site_instance->HasProcess()) {
3843 source_process_site_url =
3844 source_site_instance->GetProcess()->GetProcessLock().site_url();
3845 }
clamy21718cc22018-06-13 13:34:243846 entry = NavigationEntryImpl::FromNavigationEntry(CreateNavigationEntry(
Lukasz Anforowicz435bcb582019-07-12 20:50:063847 params.url, params.referrer, params.initiator_origin,
Sharon Yang242ef822023-05-15 21:07:323848 params.initiator_base_url, source_process_site_url,
W. James MacLean23e90a12022-12-21 04:38:213849 params.transition_type, params.is_renderer_initiated,
3850 extra_headers_crlf, browser_context_, blob_url_loader_factory,
3851 rewrite_virtual_urls));
clamy21718cc22018-06-13 13:34:243852 entry->set_source_site_instance(
3853 static_cast<SiteInstanceImpl*>(params.source_site_instance.get()));
3854 entry->SetRedirectChain(params.redirect_chain);
3855 }
3856
3857 // Set the FTN ID (only used in non-site-per-process, for tests).
3858 entry->set_frame_tree_node_id(node->frame_tree_node_id());
clamy21718cc22018-06-13 13:34:243859 entry->set_should_clear_history_list(params.should_clear_history_list);
Camille Lamy5193caa2018-10-12 11:59:423860 entry->SetIsOverridingUserAgent(override_user_agent);
3861 entry->set_has_user_gesture(has_user_gesture);
Robert Ogden011a8082019-01-23 19:04:543862 entry->set_reload_type(params.reload_type);
clamy21718cc22018-06-13 13:34:243863
clamy21718cc22018-06-13 13:34:243864 switch (params.load_type) {
3865 case LOAD_TYPE_DEFAULT:
3866 break;
3867 case LOAD_TYPE_HTTP_POST:
3868 entry->SetHasPostData(true);
3869 entry->SetPostData(params.post_data);
3870 break;
3871 case LOAD_TYPE_DATA:
Shu Yang112ad492024-07-25 17:11:543872 // LoadDataWithBaseURL is a special case that needs to assign both a base
3873 // URL and a virtual URL, while loading the actual content from a data
3874 // URL.
clamy21718cc22018-06-13 13:34:243875 entry->SetBaseURLForDataURL(params.base_url_for_data_url);
Shu Yang112ad492024-07-25 17:11:543876 entry->SetVirtualURL(params.virtual_url_for_special_cases);
Xiaohan Wang7f8052e02022-01-14 18:44:283877#if BUILDFLAG(IS_ANDROID)
clamy21718cc22018-06-13 13:34:243878 entry->SetDataURLAsString(params.data_url_as_string);
3879#endif
3880 entry->SetCanLoadLocalResources(params.can_load_local_resources);
3881 break;
Shu Yang112ad492024-07-25 17:11:543882#if BUILDFLAG(IS_ANDROID)
3883 case LOAD_TYPE_PDF_ANDROID:
3884 // Android PDF URLs show the actual PDF URL as a virtual URL, while an
3885 // internal URL is used for the navigation URL.
3886 entry->SetVirtualURL(params.virtual_url_for_special_cases);
3887 break;
3888#endif
clamy21718cc22018-06-13 13:34:243889 }
3890
3891 // TODO(clamy): NavigationEntry is meant for information that will be kept
3892 // after the navigation ended and therefore is not appropriate for
3893 // started_from_context_menu. Move started_from_context_menu to
3894 // NavigationUIData.
3895 entry->set_started_from_context_menu(params.started_from_context_menu);
3896
3897 return entry;
3898}
3899
clamyea99ea12018-05-28 13:54:233900std::unique_ptr<NavigationRequest>
Camille Lamy5193caa2018-10-12 11:59:423901NavigationControllerImpl::CreateNavigationRequestFromLoadParams(
3902 FrameTreeNode* node,
3903 const LoadURLParams& params,
3904 bool override_user_agent,
3905 bool should_replace_current_entry,
3906 bool has_user_gesture,
Antonio Sartori2f763d9d2021-04-21 10:04:143907 network::mojom::SourceLocationPtr source_location,
Camille Lamy5193caa2018-10-12 11:59:423908 ReloadType reload_type,
Lucas Furukawa Gadani5553a1582019-01-08 18:55:573909 NavigationEntryImpl* entry,
Tsuyoshi Horo167ca6432022-03-09 05:16:393910 FrameNavigationEntry* frame_entry,
Nan Lin944e9b4e2022-04-12 13:51:223911 base::TimeTicks navigation_start_time,
Garrett Tanzer405f3402022-07-21 20:12:493912 bool is_embedder_initiated_fenced_frame_navigation,
Sergey Poromovdd557c12023-03-01 11:28:453913 bool is_unfenced_top_navigation,
Camillia Smith Barnes6a643962023-03-03 00:28:583914 bool is_container_initiated,
W. James MacLean443ef3e2024-07-16 13:42:343915 net::StorageAccessApiStatus storage_access_api_status,
Arthur Sonzognic686e8f2024-01-11 08:36:373916 std::optional<std::u16string> embedder_shared_storage_context) {
Lucas Furukawa Gadani5553a1582019-01-08 18:55:573917 DCHECK_EQ(-1, GetIndexOfEntry(entry));
Camille Lamyb9ed3c52018-11-19 15:34:283918 DCHECK(frame_entry);
Nasko Oskov3c2f9e252019-01-10 17:45:533919 // All renderer-initiated navigations must have an initiator_origin.
3920 DCHECK(!params.is_renderer_initiated || params.initiator_origin.has_value());
Camille Lamyff7c4822018-11-07 15:42:513921
Camille Lamy5193caa2018-10-12 11:59:423922 GURL url_to_load;
3923 GURL virtual_url;
Nasko Oskov03912102019-01-11 00:21:323924
Camille Lamy2baa8022018-10-19 16:43:173925 // For main frames, rewrite the URL if necessary and compute the virtual URL
3926 // that should be shown in the address bar.
Ian Vollick1c6dd3e2022-04-13 02:06:263927 if (node->IsOutermostMainFrame()) {
Lukasz Anforowiczb2eb19b12020-01-25 00:40:423928 bool ignored_reverse_on_redirect = false;
Camille Lamy2baa8022018-10-19 16:43:173929 RewriteUrlForNavigation(params.url, browser_context_, &url_to_load,
Lukasz Anforowiczb2eb19b12020-01-25 00:40:423930 &virtual_url, &ignored_reverse_on_redirect);
Camille Lamy5193caa2018-10-12 11:59:423931
Shu Yang112ad492024-07-25 17:11:543932 // Both LoadDataWithBaseURL and Android PDF navigations are special cases
3933 // that need to define a virtual URL to display, which differs from the
3934 // navigation URL.
3935 if (params.load_type == LOAD_TYPE_DATA) {
3936 virtual_url = params.virtual_url_for_special_cases;
3937 }
3938#if BUILDFLAG(IS_ANDROID)
3939 if (params.load_type == LOAD_TYPE_PDF_ANDROID) {
3940 virtual_url = params.virtual_url_for_special_cases;
3941 }
3942#endif
Camille Lamy5193caa2018-10-12 11:59:423943
Camille Lamy2baa8022018-10-19 16:43:173944 if (virtual_url.is_empty())
3945 virtual_url = url_to_load;
3946
Lucas Furukawa Gadani5553a1582019-01-08 18:55:573947 CHECK(virtual_url == entry->GetVirtualURL());
Camille Lamyb9ed3c52018-11-19 15:34:283948
Aran Gilman249eb122019-12-02 23:32:463949 // This is a LOG and not a CHECK/DCHECK as URL rewrite has non-deterministic
3950 // behavior: it is possible for two calls to RewriteUrlForNavigation to
3951 // return different results, leading to a different URL in the
3952 // NavigationRequest and FrameEntry. This will be fixed once we remove the
3953 // pending NavigationEntry, as we'll only make one call to
3954 // RewriteUrlForNavigation.
3955 VLOG_IF(1, (url_to_load != frame_entry->url()))
3956 << "NavigationRequest and FrameEntry have different URLs: "
3957 << url_to_load << " vs " << frame_entry->url();
Camille Lamyb9ed3c52018-11-19 15:34:283958
Camille Lamy2baa8022018-10-19 16:43:173959 // TODO(clamy): In order to remove the pending NavigationEntry,
Lukasz Anforowiczb2eb19b12020-01-25 00:40:423960 // |virtual_url| and |ignored_reverse_on_redirect| should be stored in the
Camille Lamy2baa8022018-10-19 16:43:173961 // NavigationRequest.
3962 } else {
3963 url_to_load = params.url;
3964 virtual_url = params.url;
Camille Lamyf664f7622019-01-07 19:28:243965 CHECK(!frame_entry || url_to_load == frame_entry->url());
Camille Lamy2baa8022018-10-19 16:43:173966 }
Camille Lamy5193caa2018-10-12 11:59:423967
Ehsan Karamad44fc72112019-02-26 18:15:473968 if (node->render_manager()->is_attaching_inner_delegate()) {
3969 // Avoid starting any new navigations since this node is now preparing for
3970 // attaching an inner delegate.
3971 return nullptr;
Ehsan Karamaddd9a4142018-12-04 20:38:203972 }
Camille Lamy5193caa2018-10-12 11:59:423973
Alex Moshchuk99242832023-05-22 17:21:443974 if (!IsValidURLForNavigation(node, virtual_url, url_to_load)) {
Camille Lamy5193caa2018-10-12 11:59:423975 return nullptr;
Alex Moshchuk99242832023-05-22 17:21:443976 }
Camille Lamy5193caa2018-10-12 11:59:423977
danakjd83d706d2020-11-25 22:11:123978 // Look for a pending commit that is to another document in this
3979 // FrameTreeNode. If one exists, then the last committed URL will not be the
3980 // current URL by the time this navigation commits.
3981 bool has_pending_cross_document_commit =
3982 node->render_manager()->HasPendingCommitForCrossDocumentNavigation();
Miyoung Shina2dd6a42021-10-07 12:19:213983 bool is_currently_error_page = node->current_frame_host()->IsErrorDocument();
danakjd83d706d2020-11-25 22:11:123984
Minggang Wangb9f3fa92021-07-01 15:30:313985 blink::mojom::NavigationType navigation_type = GetNavigationType(
danakjb952ef12021-01-14 19:58:493986 /*old_url=*/node->current_url(),
3987 /*new_url=*/url_to_load, reload_type, entry, *frame_entry,
3988 has_pending_cross_document_commit, is_currently_error_page,
Garrett Tanzer267c2b82022-07-26 16:53:133989 /*is_same_document_history_load=*/false,
3990 is_embedder_initiated_fenced_frame_navigation,
3991 is_unfenced_top_navigation);
Camille Lamy5193caa2018-10-12 11:59:423992
3993 // Create the NavigationParams based on |params|.
3994
Hiroki Nakagawa4ed61282021-06-18 05:37:233995 bool is_view_source_mode = entry->IsViewSourceMode();
3996 DCHECK_EQ(is_view_source_mode, virtual_url.SchemeIs(kViewSourceScheme));
Charlie Harrison8c113a32019-01-07 16:08:293997
Antonio Sartori6984c742021-08-26 08:03:413998 blink::NavigationDownloadPolicy download_policy = params.download_policy;
Yao Xiao720ef9d62022-12-09 05:18:293999
Hiroki Nakagawa4ed61282021-06-18 05:37:234000 // Update |download_policy| if the virtual URL is view-source.
Charlie Harrison8c113a32019-01-07 16:08:294001 if (is_view_source_mode)
Yeunjoo Choi3df791a2021-02-17 07:07:254002 download_policy.SetDisallowed(blink::NavigationDownloadType::kViewSource);
Charlie Harrison8c113a32019-01-07 16:08:294003
Minggang Wangb9f3fa92021-07-01 15:30:314004 blink::mojom::CommonNavigationParamsPtr common_params =
4005 blink::mojom::CommonNavigationParams::New(
W. James MacLean23e90a12022-12-21 04:38:214006 url_to_load, params.initiator_origin, params.initiator_base_url,
Lucas Furukawa Gadanief8290a2019-07-29 20:27:514007 blink::mojom::Referrer::New(params.referrer.url,
4008 params.referrer.policy),
Scott Violetcf6ea7e2021-06-09 21:09:214009 params.transition_type, navigation_type, download_policy,
Lucas Furukawa Gadanief8290a2019-07-29 20:27:514010 should_replace_current_entry, params.base_url_for_data_url,
Tsuyoshi Horo167ca6432022-03-09 05:16:394011 navigation_start_time,
Lucas Furukawa Gadanief8290a2019-07-29 20:27:514012 params.load_type == LOAD_TYPE_HTTP_POST ? "POST" : "GET",
Antonio Sartori2f763d9d2021-04-21 10:04:144013 params.post_data, std::move(source_location),
arthursonzogniaf7c62c52020-02-12 10:49:414014 params.started_from_context_menu, has_user_gesture,
Antonio Sartori636adba2021-03-09 12:15:274015 false /* has_text_fragment_token */,
4016 network::mojom::CSPDisposition::CHECK, std::vector<int>(),
4017 params.href_translate,
Lucas Furukawa Gadanief8290a2019-07-29 20:27:514018 false /* is_history_navigation_in_new_child_frame */,
Chris Fredricksonb52bcd02023-03-28 14:48:054019 params.input_start, network::mojom::RequestDestination::kEmpty);
Camille Lamy5193caa2018-10-12 11:59:424020
Minggang Wangb9f3fa92021-07-01 15:30:314021 blink::mojom::CommitNavigationParamsPtr commit_params =
4022 blink::mojom::CommitNavigationParams::New(
Arthur Sonzognic686e8f2024-01-11 08:36:374023 std::nullopt,
Ari Chivukulac7533522024-05-14 21:52:344024 // The correct storage key will be computed before committing the
4025 // navigation.
4026 blink::StorageKey(), override_user_agent, params.redirect_chain,
Lucas Furukawa Gadani81e294b2019-08-29 16:26:324027 std::vector<network::mojom::URLResponseHeadPtr>(),
jongdeok.kim5de823b32022-06-14 04:37:504028 std::vector<net::RedirectInfo>(), params.post_content_type,
4029 common_params->url, common_params->method,
4030 params.can_load_local_resources,
Minggang Wangb9f3fa92021-07-01 15:30:314031 frame_entry->page_state().ToEncodedData(), entry->GetUniqueID(),
Yoav Weiss8c573952022-11-17 17:35:134032 entry->GetSubframeUniqueNames(node),
4033 /*intended_as_new_entry=*/true,
4034 /*pending_history_list_offset=*/-1,
Lucas Furukawa Gadania9c45682019-07-31 22:05:144035 params.should_clear_history_list ? -1 : GetLastCommittedEntryIndex(),
4036 params.should_clear_history_list ? 0 : GetEntryCount(),
Yoav Weiss8c573952022-11-17 17:35:134037 /*was_discarded=*/false, is_view_source_mode,
Minggang Wangb9f3fa92021-07-01 15:30:314038 params.should_clear_history_list,
4039 blink::mojom::NavigationTiming::New(),
Minggang Wangf59db47b2021-06-16 01:56:224040 blink::mojom::WasActivatedOption::kUnknown,
Yoav Weiss8c573952022-11-17 17:35:134041 /*navigation_token=*/base::UnguessableToken::Create(),
Minggang Wang7ee0c742021-06-16 16:16:514042 std::vector<blink::mojom::PrefetchedSignedExchangeInfoPtr>(),
Xiaohan Wang7f8052e02022-01-14 18:44:284043#if BUILDFLAG(IS_ANDROID)
Yoav Weiss8c573952022-11-17 17:35:134044 /*data_url_as_string=*/std::string(),
Lucas Furukawa Gadania9c45682019-07-31 22:05:144045#endif
Yoav Weiss8c573952022-11-17 17:35:134046 /*is_browser_initiated=*/!params.is_renderer_initiated,
Yoav Weiss8c573952022-11-17 17:35:134047 /*document_ukm_source_id=*/ukm::kInvalidSourceId,
Jiewei Qian0406fc02020-03-09 06:02:074048 node->pending_frame_policy(),
Yoav Weiss8c573952022-11-17 17:35:134049 /*force_enabled_origin_trials=*/std::vector<std::string>(),
4050 /*origin_agent_cluster=*/false,
4051 /*origin_agent_cluster_left_as_default=*/true,
4052 /*enabled_client_hints=*/
4053 std::vector<network::mojom::WebClientHintsType>(),
Liam Brady38b84562024-03-07 22:11:264054 /*is_cross_site_cross_browsing_context_group=*/false,
4055 /*should_have_sticky_user_activation=*/false,
4056 /*old_page_info=*/nullptr,
Yoav Weiss8c573952022-11-17 17:35:134057 /*http_response_code=*/-1,
Domenic Denicolacd30f5f82022-03-16 21:48:014058 blink::mojom::NavigationApiHistoryEntryArrays::New(),
Yoav Weiss8c573952022-11-17 17:35:134059 /*early_hints_preloaded_resources=*/std::vector<GURL>(),
Clark DuVall8ee487a22021-11-10 02:25:584060 // This timestamp will be populated when the commit IPC is sent.
Yoav Weiss8c573952022-11-17 17:35:134061 /*commit_sent=*/base::TimeTicks(), /*srcdoc_value=*/std::string(),
Yoav Weiss8c573952022-11-17 17:35:134062 /*should_load_data_url=*/false,
Victor Tan10d93aca2022-08-12 16:46:284063 /*ancestor_or_self_has_cspee=*/node->AncestorOrSelfHasCSPEE(),
Yoav Weiss8c573952022-11-17 17:35:134064 /*reduced_accept_language=*/std::string(),
William Liu2c825472022-10-31 12:01:444065 /*navigation_delivery_type=*/
Khushal Sagar7b26135c62022-11-08 20:25:424066 network::mojom::NavigationDeliveryType::kDefault,
Arthur Sonzognic686e8f2024-01-11 08:36:374067 /*view_transition_state=*/std::nullopt,
4068 /*soft_navigation_heuristics_task_id=*/std::nullopt,
sbinglera07ae732022-12-02 20:49:054069 /*modified_runtime_features=*/
Jiewei Qian87951f52023-10-17 01:33:464070 base::flat_map<::blink::mojom::RuntimeFeature, bool>(),
Arthur Sonzognic686e8f2024-01-11 08:36:374071 /*fenced_frame_properties=*/std::nullopt,
Chris Fredricksonb52bcd02023-03-28 14:48:054072 /*not_restored_reasons=*/nullptr,
Chris Fredrickson9ffdf5b2024-07-09 20:05:094073 /*load_with_storage_access=*/
4074 net::StorageAccessApiStatus::kNone,
Arthur Sonzognic686e8f2024-01-11 08:36:374075 /*browsing_context_group_info=*/std::nullopt,
Nan Linda394ba2023-11-03 21:17:374076 /*lcpp_hint=*/nullptr, blink::CreateDefaultRendererContentSettings(),
Kyra800d1d012024-03-27 17:05:484077 /*cookie_deprecation_label=*/std::nullopt,
Khushal Sagar81f89812024-06-11 13:40:314078 /*visited_link_salt=*/std::nullopt,
4079 /*local_surface_id=*/std::nullopt);
Xiaohan Wang7f8052e02022-01-14 18:44:284080#if BUILDFLAG(IS_ANDROID)
Camille Lamy5193caa2018-10-12 11:59:424081 if (ValidateDataURLAsString(params.data_url_as_string)) {
danakj529a3eba2024-04-18 20:14:564082 commit_params->data_url_as_string = params.data_url_as_string->as_string();
Camille Lamy5193caa2018-10-12 11:59:424083 }
4084#endif
4085
Lucas Furukawa Gadania9c45682019-07-31 22:05:144086 commit_params->was_activated = params.was_activated;
Mike Jacksone2aa7af2023-05-17 06:45:074087 commit_params->navigation_timing->system_entropy_at_navigation_start =
4088 SystemEntropyUtils::ComputeSystemEntropyForFrameTreeNode(
4089 node, params.suggested_system_entropy);
Camille Lamy5193caa2018-10-12 11:59:424090
Camille Lamy5193caa2018-10-12 11:59:424091 // extra_headers in params are \n separated; NavigationRequests want \r\n.
4092 std::string extra_headers_crlf;
4093 base::ReplaceChars(params.extra_headers, "\n", "\r\n", &extra_headers_crlf);
Yao Xiaodc5ed102019-06-04 19:19:094094
Alex Moshchuk9321e6a2022-12-07 21:58:314095 auto navigation_request = NavigationRequest::Create(
Lucas Furukawa Gadania9c45682019-07-31 22:05:144096 node, std::move(common_params), std::move(commit_params),
Takashi Toyoshimae87b7be2021-01-22 11:51:084097 !params.is_renderer_initiated, params.was_opener_suppressed,
Hiroshige Hayashizakif07ad7812023-05-10 02:26:094098 params.initiator_frame_token, params.initiator_process_id,
4099 extra_headers_crlf, frame_entry, entry, params.is_form_submission,
John Delaney50425f82020-04-07 16:26:214100 params.navigation_ui_data ? params.navigation_ui_data->Clone() : nullptr,
Yao Xiao720ef9d62022-12-09 05:18:294101 params.impression, params.initiator_activation_and_ad_status,
Sergey Poromovdd557c12023-03-01 11:28:454102 params.is_pdf, is_embedder_initiated_fenced_frame_navigation,
W. James MacLean443ef3e2024-07-16 13:42:344103 is_container_initiated, params.has_rel_opener, storage_access_api_status,
Kevin McNee6455638a2024-06-27 22:05:034104 embedder_shared_storage_context);
Yao Xiaodc5ed102019-06-04 19:19:094105 navigation_request->set_from_download_cross_origin_redirect(
4106 params.from_download_cross_origin_redirect);
W. James MacLean00568d72022-02-24 19:36:554107 navigation_request->set_force_new_browsing_instance(
4108 params.force_new_browsing_instance);
Mustafa Emre Acer1001b3d2024-07-09 23:10:434109 if (params.force_no_https_upgrade) {
4110 navigation_request->set_force_no_https_upgrade();
4111 }
Yao Xiaodc5ed102019-06-04 19:19:094112 return navigation_request;
Camille Lamy5193caa2018-10-12 11:59:424113}
4114
4115std::unique_ptr<NavigationRequest>
4116NavigationControllerImpl::CreateNavigationRequestFromEntry(
clamyea99ea12018-05-28 13:54:234117 FrameTreeNode* frame_tree_node,
Lucas Furukawa Gadani5553a1582019-01-08 18:55:574118 NavigationEntryImpl* entry,
clamyea99ea12018-05-28 13:54:234119 FrameNavigationEntry* frame_entry,
4120 ReloadType reload_type,
4121 bool is_same_document_history_load,
Nate Chapin45f620582021-09-30 17:45:434122 bool is_history_navigation_in_new_child_frame,
Arthur Sonzognic686e8f2024-01-11 08:36:374123 const std::optional<blink::LocalFrameToken>& initiator_frame_token,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:334124 int initiator_process_id,
Arthur Sonzognic686e8f2024-01-11 08:36:374125 std::optional<blink::scheduler::TaskAttributionId>
Yoav Weiss8c573952022-11-17 17:35:134126 soft_navigation_heuristics_task_id) {
Alex Moshchuk47d1a4bd2020-06-01 22:15:344127 DCHECK(frame_entry);
clamyea99ea12018-05-28 13:54:234128 GURL dest_url = frame_entry->url();
Rakina Zata Amnif297a802022-01-18 03:53:434129 // We should never navigate to an existing initial NavigationEntry that is the
4130 // initial NavigationEntry for the initial empty document that hasn't been
4131 // overridden by the synchronous about:blank commit, to preserve previous
4132 // behavior where trying to reload when the main frame is on the initial empty
4133 // document won't result in a navigation.
4134 // See also https://crbug.com/1277414.
4135 DCHECK(!entry->IsInitialEntryNotForSynchronousAboutBlank());
Nasko Oskov03912102019-01-11 00:21:324136
clamyea99ea12018-05-28 13:54:234137 Referrer dest_referrer = frame_entry->referrer();
clamyea99ea12018-05-28 13:54:234138
Ehsan Karamad44fc72112019-02-26 18:15:474139 if (frame_tree_node->render_manager()->is_attaching_inner_delegate()) {
4140 // Avoid starting any new navigations since this node is now preparing for
4141 // attaching an inner delegate.
4142 return nullptr;
Ehsan Karamaddd9a4142018-12-04 20:38:204143 }
4144
Alex Moshchuk99242832023-05-22 17:21:444145 if (!IsValidURLForNavigation(frame_tree_node, entry->GetVirtualURL(),
4146 dest_url)) {
clamyea99ea12018-05-28 13:54:234147 return nullptr;
4148 }
4149
clamyea99ea12018-05-28 13:54:234150 // This will be used to set the Navigation Timing API navigationStart
4151 // parameter for browser navigations in new tabs (intents, tabs opened through
4152 // "Open link in new tab"). If the navigation must wait on the current
4153 // RenderFrameHost to execute its BeforeUnload event, the navigation start
4154 // will be updated when the BeforeUnload ack is received.
Mike Jacksone2aa7af2023-05-17 06:45:074155
clamyea99ea12018-05-28 13:54:234156 base::TimeTicks navigation_start = base::TimeTicks::Now();
Mike Jacksone2aa7af2023-05-17 06:45:074157 const auto navigation_start_system_entropy =
4158 SystemEntropyUtils::ComputeSystemEntropyForFrameTreeNode(
4159 frame_tree_node, blink::mojom::SystemEntropy::kNormal);
clamyea99ea12018-05-28 13:54:234160
danakjd83d706d2020-11-25 22:11:124161 // Look for a pending commit that is to another document in this
4162 // FrameTreeNode. If one exists, then the last committed URL will not be the
4163 // current URL by the time this navigation commits.
4164 bool has_pending_cross_document_commit =
4165 frame_tree_node->render_manager()
4166 ->HasPendingCommitForCrossDocumentNavigation();
danakjb952ef12021-01-14 19:58:494167 bool is_currently_error_page =
Miyoung Shina2dd6a42021-10-07 12:19:214168 frame_tree_node->current_frame_host()->IsErrorDocument();
danakjd83d706d2020-11-25 22:11:124169
Minggang Wangb9f3fa92021-07-01 15:30:314170 blink::mojom::NavigationType navigation_type = GetNavigationType(
danakjd83d706d2020-11-25 22:11:124171 /*old_url=*/frame_tree_node->current_url(),
4172 /*new_url=*/dest_url, reload_type, entry, *frame_entry,
danakjb952ef12021-01-14 19:58:494173 has_pending_cross_document_commit, is_currently_error_page,
Garrett Tanzer405f3402022-07-21 20:12:494174 is_same_document_history_load,
Garrett Tanzer267c2b82022-07-26 16:53:134175 /*is_embedder_initiated_fenced_frame_navigation=*/false,
Garrett Tanzer405f3402022-07-21 20:12:494176 /*is_unfenced_top_navigation=*/false);
Camille Lamy5193caa2018-10-12 11:59:424177
4178 // A form submission may happen here if the navigation is a
4179 // back/forward/reload navigation that does a form resubmission.
4180 scoped_refptr<network::ResourceRequestBody> request_body;
4181 std::string post_content_type;
Alison Galed94ce4f2024-04-22 15:20:394182 // TODO(crbug.com/41440869) Store |is_form_submission| in the history
jongdeok.kim5de823b32022-06-14 04:37:504183 // entry. This way, it could be directly retrieved here. Right now, it is only
4184 // partially recovered when request.method == "POST" and request.body exists.
4185 bool is_form_submission = false;
Camille Lamy5193caa2018-10-12 11:59:424186 if (frame_entry->method() == "POST") {
4187 request_body = frame_entry->GetPostData(&post_content_type);
4188 // Might have a LF at end.
Peter Kastingb53b81912021-04-28 19:23:304189 post_content_type = std::string(
4190 base::TrimWhitespaceASCII(post_content_type, base::TRIM_ALL));
jongdeok.kim5de823b32022-06-14 04:37:504191 is_form_submission = !!request_body;
Camille Lamy5193caa2018-10-12 11:59:424192 }
4193
4194 // Create the NavigationParams based on |entry| and |frame_entry|.
Minggang Wangb9f3fa92021-07-01 15:30:314195 blink::mojom::CommonNavigationParamsPtr common_params =
Lucas Furukawa Gadanief8290a2019-07-29 20:27:514196 entry->ConstructCommonNavigationParams(
4197 *frame_entry, request_body, dest_url,
4198 blink::mojom::Referrer::New(dest_referrer.url, dest_referrer.policy),
Tarun Bansalbcd62c82022-01-18 17:27:384199 navigation_type, navigation_start,
Charlie Hu5ffc0152019-12-06 15:59:534200 base::TimeTicks() /* input_start */);
Lucas Furukawa Gadanief8290a2019-07-29 20:27:514201 common_params->is_history_navigation_in_new_child_frame =
Arthur Hemerybee4a752019-05-29 10:50:554202 is_history_navigation_in_new_child_frame;
Camille Lamy5193caa2018-10-12 11:59:424203
4204 // TODO(clamy): |intended_as_new_entry| below should always be false once
4205 // Reload no longer leads to this being called for a pending NavigationEntry
4206 // of index -1.
Minggang Wangb9f3fa92021-07-01 15:30:314207 blink::mojom::CommitNavigationParamsPtr commit_params =
Lucas Furukawa Gadania9c45682019-07-31 22:05:144208 entry->ConstructCommitNavigationParams(
Rakina Zata Amnic7367852022-11-07 17:10:404209 *frame_entry, common_params->url, common_params->method,
4210 entry->GetSubframeUniqueNames(frame_tree_node),
Lucas Furukawa Gadania9c45682019-07-31 22:05:144211 GetPendingEntryIndex() == -1 /* intended_as_new_entry */,
Charlie Hu5ffc0152019-12-06 15:59:534212 GetIndexOfEntry(entry), GetLastCommittedEntryIndex(), GetEntryCount(),
Liam Bradyd2a41e152022-07-19 13:58:484213 frame_tree_node->pending_frame_policy(),
Yoav Weiss8c573952022-11-17 17:35:134214 frame_tree_node->AncestorOrSelfHasCSPEE(),
Mike Jacksone2aa7af2023-05-17 06:45:074215 navigation_start_system_entropy, soft_navigation_heuristics_task_id);
Lucas Furukawa Gadania9c45682019-07-31 22:05:144216 commit_params->post_content_type = post_content_type;
Mike Jacksone2aa7af2023-05-17 06:45:074217 commit_params->navigation_timing->system_entropy_at_navigation_start =
4218 SystemEntropyUtils::ComputeSystemEntropyForFrameTreeNode(
4219 frame_tree_node, blink::mojom::SystemEntropy::kNormal);
Camille Lamy5193caa2018-10-12 11:59:424220
W. James MacLeanb7d6092682022-10-05 15:23:264221 if (common_params->url.IsAboutSrcdoc()) {
4222 // TODO(wjmaclean): initialize this in NavigationRequest's constructor
4223 // instead.
W. James MacLean81b8d01f2022-01-25 20:50:594224 commit_params->srcdoc_value = frame_tree_node->srcdoc_value();
W. James MacLeanb7d6092682022-10-05 15:23:264225 }
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:334226 const bool is_browser_initiated = !initiator_frame_token;
Alex Moshchuk9321e6a2022-12-07 21:58:314227 return NavigationRequest::Create(
Lucas Furukawa Gadania9c45682019-07-31 22:05:144228 frame_tree_node, std::move(common_params), std::move(commit_params),
Nate Chapin45f620582021-09-30 17:45:434229 is_browser_initiated, false /* was_opener_suppressed */,
Hiroshige Hayashizaki5466bfe82023-05-17 00:34:334230 initiator_frame_token, initiator_process_id, entry->extra_headers(),
4231 frame_entry, entry, is_form_submission, nullptr /* navigation_ui_data */,
Arthur Sonzognic686e8f2024-01-11 08:36:374232 std::nullopt /* impression */,
Yao Xiao720ef9d62022-12-09 05:18:294233 blink::mojom::NavigationInitiatorActivationAndAdStatus::
4234 kDidNotStartWithTransientActivation,
Daniel Hosseinianf0fbfb42021-09-08 02:20:474235 false /* is_pdf */);
clamyea99ea12018-05-28 13:54:234236}
4237
[email protected]d202a7c2012-01-04 07:53:474238void NavigationControllerImpl::NotifyNavigationEntryCommitted(
[email protected]8ff00d72012-10-23 19:12:214239 LoadCommittedDetails* details) {
[email protected]6286a3792013-10-09 04:03:274240 details->entry = GetLastCommittedEntry();
[email protected]df1af242009-05-01 00:11:404241
Takashi Toyoshimaea534ef22021-07-21 03:27:594242 // We need to notify the ssl_manager_ before the WebContents so the
[email protected]df1af242009-05-01 00:11:404243 // location bar will have up-to-date information about the security style
4244 // when it wants to draw. See http://crbug.com/11157
[email protected]b0f724c2013-09-05 04:21:134245 ssl_manager_.DidCommitProvisionalLoad(*details);
[email protected]df1af242009-05-01 00:11:404246
Abhijeet Kandalkar3dc6e602022-11-09 05:08:374247 delegate_->NotifyNavigationStateChangedFromController(INVALIDATE_TYPE_ALL);
[email protected]ec6c05f2013-10-23 18:41:574248 delegate_->NotifyNavigationEntryCommitted(*details);
initial.commit09911bf2008-07-26 23:55:294249}
4250
initial.commit09911bf2008-07-26 23:55:294251// static
[email protected]d202a7c2012-01-04 07:53:474252size_t NavigationControllerImpl::max_entry_count() {
[email protected]9b51970d2011-12-09 23:10:234253 if (max_entry_count_for_testing_ != kMaxEntryCountForTestingNotSet)
Aran Gilman37d11632019-10-08 23:07:154254 return max_entry_count_for_testing_;
Miyoung Shin1c565c912021-03-17 12:11:214255 return blink::kMaxSessionHistoryEntries;
[email protected]9b51970d2011-12-09 23:10:234256}
4257
[email protected]d202a7c2012-01-04 07:53:474258void NavigationControllerImpl::SetActive(bool is_active) {
[email protected]ee613922009-09-02 20:38:224259 if (is_active && needs_reload_)
4260 LoadIfNecessary();
Khushal Sagarace0e7342024-08-07 21:34:214261
4262 if (frame_tree_->is_primary();
4263 auto* cache = GetNavigationEntryScreenshotCache()) {
4264 cache->SetVisible(is_active);
4265 }
initial.commit09911bf2008-07-26 23:55:294266}
4267
[email protected]d202a7c2012-01-04 07:53:474268void NavigationControllerImpl::LoadIfNecessary() {
Rakina Zata Amnid605d462022-06-01 10:17:034269 SCOPED_CRASH_KEY_BOOL("nav_reentrancy_caller1", "LoadIf_pending",
4270 !!pending_entry_);
initial.commit09911bf2008-07-26 23:55:294271 if (!needs_reload_)
4272 return;
4273
Bo Liucdfa4b12018-11-06 00:21:444274 UMA_HISTOGRAM_ENUMERATION("Navigation.LoadIfNecessaryType",
4275 needs_reload_type_);
4276
initial.commit09911bf2008-07-26 23:55:294277 // Calling Reload() results in ignoring state, and not loading.
Xinghui Lue4e50be2024-05-15 21:46:004278 // Explicitly use NavigateToExistingPendingEntry so that the renderer uses the
initial.commit09911bf2008-07-26 23:55:294279 // cached state.
Xinghui Lue4e50be2024-05-15 21:46:004280 if (entry_replaced_by_post_commit_error_) {
4281 // If the current entry is a post commit error, we reload the entry it
4282 // replaced instead. We leave the error entry in place until a commit
4283 // replaces it, but the pending entry points to the original entry in the
4284 // meantime. Note that NavigateToExistingPendingEntry is able to handle the
4285 // case that pending_entry_ != entries_[pending_entry_index_].
4286 // Note that this handling is similar to
4287 // `NavigationControllerImpl::Reload()`.
4288 pending_entry_ = entry_replaced_by_post_commit_error_.get();
4289 pending_entry_index_ = GetCurrentEntryIndex();
4290 NavigateToExistingPendingEntry(
4291 ReloadType::NONE,
4292 /*initiator_rfh=*/nullptr,
4293 /*soft_navigation_heuristics_task_id=*/std::nullopt,
4294 /*navigation_api_key=*/nullptr);
4295 } else if (pending_entry_) {
Yoav Weiss8c573952022-11-17 17:35:134296 NavigateToExistingPendingEntry(
4297 ReloadType::NONE,
4298 /*initiator_rfh=*/nullptr,
Arthur Sonzognic686e8f2024-01-11 08:36:374299 /*soft_navigation_heuristics_task_id=*/std::nullopt,
Yoav Weiss8c573952022-11-17 17:35:134300 /*navigation_api_key=*/nullptr);
Rakina Zata Amnie2d31312022-11-18 03:38:454301 } else if (!GetLastCommittedEntry()
Rakina Zata Amnif297a802022-01-18 03:53:434302 ->IsInitialEntryNotForSynchronousAboutBlank()) {
arthursonzogni5c4c202d2017-04-25 23:41:274303 pending_entry_ = entries_[last_committed_entry_index_].get();
avicc872d7242015-08-19 21:26:344304 pending_entry_index_ = last_committed_entry_index_;
Yoav Weiss8c573952022-11-17 17:35:134305 NavigateToExistingPendingEntry(
4306 ReloadType::NONE,
4307 /*initiator_rfh=*/nullptr,
Arthur Sonzognic686e8f2024-01-11 08:36:374308 /*soft_navigation_heuristics_task_id=*/std::nullopt,
Yoav Weiss8c573952022-11-17 17:35:134309 /*navigation_api_key=*/nullptr);
avicc872d7242015-08-19 21:26:344310 } else {
Rakina Zata Amnif297a802022-01-18 03:53:434311 // We should never navigate to an existing initial NavigationEntry that is
4312 // the initial NavigationEntry for the initial empty document that hasn't
4313 // been overridden by the synchronous about:blank commit, to preserve
4314 // legacy behavior where trying to reload when the main frame is on the
4315 // initial empty document won't result in a navigation. See also
4316 // https://crbug.com/1277414. If there is something to reload, the
4317 // successful reload will clear the |needs_reload_| flag. Otherwise, just do
4318 // it here.
avicc872d7242015-08-19 21:26:344319 needs_reload_ = false;
4320 }
initial.commit09911bf2008-07-26 23:55:294321}
4322
Kevin McNeeccca6172021-10-19 17:11:144323base::WeakPtr<NavigationHandle>
4324NavigationControllerImpl::LoadPostCommitErrorPage(
Carlos IL42b416592019-10-07 23:10:364325 RenderFrameHost* render_frame_host,
4326 const GURL& url,
Lei Zhanga4770832023-07-19 18:02:364327 const std::string& error_page_html) {
Rakina Zata Amni919b7922020-12-11 09:03:134328 RenderFrameHostImpl* rfhi =
4329 static_cast<RenderFrameHostImpl*>(render_frame_host);
Sreeja Kamishettydb8e2892021-03-10 09:30:584330
4331 // Only active documents can load post-commit error pages:
4332 // - If the document is in pending deletion, the browser already committed to
4333 // destroying this RenderFrameHost so ignore loading the error page.
4334 // - If the document is in back-forward cache, it's not allowed to navigate as
4335 // it should remain frozen. Ignore the request and evict the document from
4336 // back-forward cache.
4337 // - If the document is prerendering, it can navigate but when loading error
4338 // pages, cancel prerendering.
Fergal Daly1336ac642021-09-14 15:13:114339 if (rfhi->IsInactiveAndDisallowActivation(
4340 DisallowActivationReasonId::kLoadPostCommitErrorPage)) {
Kevin McNeeccca6172021-10-19 17:11:144341 return nullptr;
Fergal Daly1336ac642021-09-14 15:13:114342 }
Sreeja Kamishettydb8e2892021-03-10 09:30:584343
Rakina Zata Amni919b7922020-12-11 09:03:134344 FrameTreeNode* node = rfhi->frame_tree_node();
John Delaney131ad362019-08-08 21:57:414345
Minggang Wangb9f3fa92021-07-01 15:30:314346 blink::mojom::CommonNavigationParamsPtr common_params =
Minggang Wanga13c796e2021-07-02 05:54:434347 blink::CreateCommonNavigationParams();
Rakina Zata Amnid2da1542020-12-23 00:52:594348 // |url| might be empty, such as when LoadPostCommitErrorPage happens before
4349 // the frame actually committed (e.g. iframe with "src" set to a
4350 // slow-responding URL). We should rewrite the URL to about:blank in this
4351 // case, as the renderer will only think a page is an error page if it has a
4352 // non-empty unreachable URL.
Rakina Zata Amni919b7922020-12-11 09:03:134353 common_params->url = url.is_empty() ? GURL("about:blank") : url;
Minggang Wangb9f3fa92021-07-01 15:30:314354 blink::mojom::CommitNavigationParamsPtr commit_params =
Minggang Wanga13c796e2021-07-02 05:54:434355 blink::CreateCommitNavigationParams();
Antonio Sartori58591c892021-04-21 06:54:334356 commit_params->original_url = common_params->url;
John Delaney131ad362019-08-08 21:57:414357
Mike Jacksone2aa7af2023-05-17 06:45:074358 commit_params->navigation_timing->system_entropy_at_navigation_start =
4359 SystemEntropyUtils::ComputeSystemEntropyForFrameTreeNode(
4360 node, blink::mojom::SystemEntropy::kNormal);
4361
arthursonzogni70ac7302020-05-28 08:49:054362 // TODO(arthursonzogni): Consider providing the minimal capabilities to the
4363 // error pages.
Liam Brady34639ec92023-10-13 19:50:454364 commit_params->frame_policy = node->pending_frame_policy();
arthursonzogni70ac7302020-05-28 08:49:054365
John Delaney131ad362019-08-08 21:57:414366 std::unique_ptr<NavigationRequest> navigation_request =
4367 NavigationRequest::CreateBrowserInitiated(
4368 node, std::move(common_params), std::move(commit_params),
Hiroshige Hayashizakif07ad7812023-05-10 02:26:094369 false /* was_opener_suppressed */, "" /* extra_headers */,
4370 nullptr /* frame_entry */, nullptr /* entry */,
4371 false /* is_form_submission */, nullptr /* navigation_ui_data */,
Arthur Sonzognic686e8f2024-01-11 08:36:374372 std::nullopt /* impression */, false /* is_pdf */);
Carlos IL42b416592019-10-07 23:10:364373 navigation_request->set_post_commit_error_page_html(error_page_html);
Lei Zhanga4770832023-07-19 18:02:364374 navigation_request->set_net_error(net::ERR_BLOCKED_BY_CLIENT);
Charlie Reis09952ee2022-12-08 16:35:074375 node->TakeNavigationRequest(std::move(navigation_request));
John Delaney131ad362019-08-08 21:57:414376 DCHECK(node->navigation_request());
Kevin McNeeccca6172021-10-19 17:11:144377
4378 // Calling BeginNavigation may destroy the NavigationRequest.
4379 base::WeakPtr<NavigationRequest> created_navigation_request(
4380 node->navigation_request()->GetWeakPtr());
John Delaney131ad362019-08-08 21:57:414381 node->navigation_request()->BeginNavigation();
Kevin McNeeccca6172021-10-19 17:11:144382 return created_navigation_request;
John Delaney131ad362019-08-08 21:57:414383}
4384
Lucas Furukawa Gadani5553a1582019-01-08 18:55:574385void NavigationControllerImpl::NotifyEntryChanged(NavigationEntry* entry) {
[email protected]8ff00d72012-10-23 19:12:214386 EntryChangedDetails det;
[email protected]534e54b2008-08-13 15:40:094387 det.changed_entry = entry;
Aran Gilman37d11632019-10-08 23:07:154388 det.index = GetIndexOfEntry(NavigationEntryImpl::FromNavigationEntry(entry));
Sam McNally5c087a32017-08-25 01:46:144389 delegate_->NotifyNavigationEntryChanged(det);
initial.commit09911bf2008-07-26 23:55:294390}
4391
[email protected]d202a7c2012-01-04 07:53:474392void NavigationControllerImpl::FinishRestore(int selected_index,
[email protected]2ca1ea662012-10-04 02:26:364393 RestoreType type) {
Alison Gale770f3fc2024-04-27 00:39:584394 // TODO(crbug.com/40816356): Don't allow an index of -1, which would
Charlie Reis23c26da2022-01-29 00:57:474395 // represent a no-committed-entry state.
4396 DCHECK(selected_index >= -1 && selected_index < GetEntryCount());
[email protected]2ca1ea662012-10-04 02:26:364397 ConfigureEntriesForRestore(&entries_, type);
Alison Gale770f3fc2024-04-27 00:39:584398 // TODO(crbug.com/40816356): This will be pointing to the wrong entry
Charlie Reis23c26da2022-01-29 00:57:474399 // if `entries_` contains pre-existing entries from the NavigationController
4400 // before restore, which would not be removed and will be at the front of the
4401 // entries list, causing the index to be off by the amount of pre-existing
4402 // entries in the list. Fix this to point to the correct entry.
initial.commit09911bf2008-07-26 23:55:294403 last_committed_entry_index_ = selected_index;
initial.commit09911bf2008-07-26 23:55:294404}
[email protected]765b35502008-08-21 00:51:204405
arthursonzogni69a6a1b2019-09-17 09:23:004406void NavigationControllerImpl::DiscardNonCommittedEntries() {
Rakina Zata Amnia4e27222021-12-22 01:05:004407 DiscardNonCommittedEntriesWithCommitDetails(nullptr /* commit_details */);
4408}
4409
4410void NavigationControllerImpl::DiscardNonCommittedEntriesWithCommitDetails(
4411 LoadCommittedDetails* commit_details) {
Michael Thiessen9b14d512019-09-23 21:19:474412 // Avoid sending a notification if there is nothing to discard.
Michael Thiessenc5676d22019-09-25 22:32:104413 // TODO(mthiesse): Temporarily checking failed_pending_entry_id_ to help
4414 // diagnose https://bugs.chromium.org/p/chromium/issues/detail?id=1007570.
Carlos IL4dea8902020-05-26 15:14:294415 if (!pending_entry_ && failed_pending_entry_id_ == 0) {
Michael Thiessen9b14d512019-09-23 21:19:474416 return;
Michael Thiessenc5676d22019-09-25 22:32:104417 }
avi45a72532015-04-07 21:01:454418 DiscardPendingEntry(false);
Rakina Zata Amnidaa84f62022-02-17 00:55:314419
4420 if (!delegate_)
4421 return;
Abhijeet Kandalkar3dc6e602022-11-09 05:08:374422 delegate_->NotifyNavigationStateChangedFromController(INVALIDATE_TYPE_ALL);
[email protected]b12eb222013-09-10 00:11:484423}
4424
avi7c6f35e2015-05-08 17:52:384425int NavigationControllerImpl::GetEntryIndexWithUniqueID(
4426 int nav_entry_id) const {
4427 for (int i = static_cast<int>(entries_.size()) - 1; i >= 0; --i) {
4428 if (entries_[i]->GetUniqueID() == nav_entry_id)
4429 return i;
4430 }
4431 return -1;
4432}
4433
[email protected]d202a7c2012-01-04 07:53:474434void NavigationControllerImpl::InsertEntriesFrom(
Lucas Furukawa Gadani5553a1582019-01-08 18:55:574435 NavigationControllerImpl* source,
[email protected]e1cd5452010-08-26 18:03:254436 int max_index) {
Lucas Furukawa Gadani5553a1582019-01-08 18:55:574437 DCHECK_LE(max_index, source->GetEntryCount());
Kevin McNee433daf242023-10-31 20:15:594438 NavigationEntryRestoreContextImpl context;
[email protected]e1cd5452010-08-26 18:03:254439 for (int i = 0; i < max_index; i++) {
Nate Chapin9f169072021-06-09 19:32:374440 // Normally, cloning a NavigationEntryImpl results in sharing
4441 // FrameNavigationEntries between the original and the clone. However, when
4442 // cloning from a different NavigationControllerImpl, we want to fork the
4443 // FrameNavigationEntries.
Nate Chapin9f169072021-06-09 19:32:374444 entries_.insert(entries_.begin() + i,
Kevin McNee433daf242023-10-31 20:15:594445 source->entries_[i]->CloneWithoutSharing(&context));
[email protected]e1cd5452010-08-26 18:03:254446 }
Rakina Zata Amnie2d31312022-11-18 03:38:454447 DCHECK_GE(entries_.size(), 1u);
arthursonzogni5c4c202d2017-04-25 23:41:274448 DCHECK(pending_entry_index_ == -1 ||
4449 pending_entry_ == GetEntryAtIndex(pending_entry_index_));
[email protected]e1cd5452010-08-26 18:03:254450}
[email protected]c5b88d82012-10-06 17:03:334451
4452void NavigationControllerImpl::SetGetTimestampCallbackForTest(
Makoto Shimazud2aa2202019-10-09 13:57:184453 const base::RepeatingCallback<base::Time()>& get_timestamp_callback) {
[email protected]c5b88d82012-10-06 17:03:334454 get_timestamp_callback_ = get_timestamp_callback;
4455}
[email protected]8ff00d72012-10-23 19:12:214456
Shivani Sharmaffb32b82019-04-09 16:58:474457// History manipulation intervention:
4458void NavigationControllerImpl::SetShouldSkipOnBackForwardUIIfNeeded(
Shivani Sharmaffb32b82019-04-09 16:58:474459 bool replace_entry,
Shivani Sharmaeef521b2024-01-18 13:03:564460 bool previous_document_had_history_intervention_activation,
Alexander Timine3ec4192020-04-20 16:39:404461 bool is_renderer_initiated,
4462 ukm::SourceId previous_page_load_ukm_source_id) {
Shivani Sharmaeef521b2024-01-18 13:03:564463 // Note that for a subframe,
4464 // previous_document_had_history_intervention_activation is true if the
Shivani Sharma712d5d72019-04-16 21:56:454465 // gesture happened in any subframe (propagated to main frame) or in the main
4466 // frame itself.
Shivani Sharmaeef521b2024-01-18 13:03:564467 if (replace_entry || previous_document_had_history_intervention_activation ||
shivanigithubcceeacf2020-03-06 20:00:274468 !is_renderer_initiated) {
Shivani Sharmaffb32b82019-04-09 16:58:474469 return;
4470 }
4471 if (last_committed_entry_index_ == -1)
4472 return;
4473
Shivani Sharmac4cc8922019-04-18 03:11:174474 SetSkippableForSameDocumentEntries(last_committed_entry_index_, true);
Shivani Sharmaffb32b82019-04-09 16:58:474475
Alexander Timine3ec4192020-04-20 16:39:404476 // Log UKM with the URL we are navigating away from.
4477 ukm::builders::HistoryManipulationIntervention(
4478 previous_page_load_ukm_source_id)
4479 .Record(ukm::UkmRecorder::Get());
Shivani Sharmaffb32b82019-04-09 16:58:474480}
4481
Shivani Sharmac4cc8922019-04-18 03:11:174482void NavigationControllerImpl::SetSkippableForSameDocumentEntries(
4483 int reference_index,
4484 bool skippable) {
4485 auto* reference_entry = GetEntryAtIndex(reference_index);
4486 reference_entry->set_should_skip_on_back_forward_ui(skippable);
4487
4488 int64_t document_sequence_number =
4489 reference_entry->root_node()->frame_entry->document_sequence_number();
4490 for (int index = 0; index < GetEntryCount(); index++) {
4491 auto* entry = GetEntryAtIndex(index);
4492 if (entry->root_node()->frame_entry->document_sequence_number() ==
4493 document_sequence_number) {
4494 entry->set_should_skip_on_back_forward_ui(skippable);
4495 }
4496 }
4497}
4498
arthursonzogni66f711c2019-10-08 14:40:364499std::unique_ptr<NavigationControllerImpl::PendingEntryRef>
4500NavigationControllerImpl::ReferencePendingEntry() {
4501 DCHECK(pending_entry_);
4502 auto pending_entry_ref =
4503 std::make_unique<PendingEntryRef>(weak_factory_.GetWeakPtr());
4504 pending_entry_refs_.insert(pending_entry_ref.get());
4505 return pending_entry_ref;
4506}
4507
4508void NavigationControllerImpl::PendingEntryRefDeleted(PendingEntryRef* ref) {
4509 // Ignore refs that don't correspond to the current pending entry.
4510 auto it = pending_entry_refs_.find(ref);
4511 if (it == pending_entry_refs_.end())
4512 return;
4513 pending_entry_refs_.erase(it);
4514
4515 if (!pending_entry_refs_.empty())
4516 return;
4517
4518 // The pending entry may be deleted before the last PendingEntryRef.
4519 if (!pending_entry_)
4520 return;
4521
4522 // We usually clear the pending entry when the matching NavigationRequest
4523 // fails, so that an arbitrary URL isn't left visible above a committed page.
4524 //
4525 // However, we do preserve the pending entry in some cases, such as on the
4526 // initial navigation of an unmodified blank tab. We also allow the delegate
4527 // to say when it's safe to leave aborted URLs in the omnibox, to let the
4528 // user edit the URL and try again. This may be useful in cases that the
4529 // committed page cannot be attacker-controlled. In these cases, we still
4530 // allow the view to clear the pending entry and typed URL if the user
4531 // requests (e.g., hitting Escape with focus in the address bar).
4532 //
4533 // Do not leave the pending entry visible if it has an invalid URL, since this
4534 // might be formatted in an unexpected or unsafe way.
4535 // TODO(creis): Block navigations to invalid URLs in https://crbug.com/850824.
arthursonzogni66f711c2019-10-08 14:40:364536 bool should_preserve_entry =
4537 (pending_entry_ == GetVisibleEntry()) &&
4538 pending_entry_->GetURL().is_valid() &&
4539 (IsUnmodifiedBlankTab() || delegate_->ShouldPreserveAbortedURLs());
4540 if (should_preserve_entry)
4541 return;
4542
4543 DiscardPendingEntry(true);
Abhijeet Kandalkar3dc6e602022-11-09 05:08:374544 delegate_->NotifyNavigationStateChangedFromController(INVALIDATE_TYPE_URL);
arthursonzogni66f711c2019-10-08 14:40:364545}
4546
Titouan Rigoudy6ec70402021-02-02 15:42:194547std::unique_ptr<PolicyContainerPolicies>
4548NavigationControllerImpl::ComputePolicyContainerPoliciesForFrameEntry(
Antonio Sartori78a749f2020-11-30 12:03:394549 RenderFrameHostImpl* rfh,
4550 bool is_same_document,
Rakina Zata Amniafd3c6582021-11-30 06:19:174551 const GURL& url) {
Antonio Sartori78a749f2020-11-30 12:03:394552 if (is_same_document) {
Rakina Zata Amnie2d31312022-11-18 03:38:454553 DCHECK(GetLastCommittedEntry());
Antonio Sartori78a749f2020-11-30 12:03:394554 FrameNavigationEntry* previous_frame_entry =
4555 GetLastCommittedEntry()->GetFrameEntry(rfh->frame_tree_node());
4556
Alison Gale770f3fc2024-04-27 00:39:584557 // TODO(crbug.com/40467594): Remove this nullptr check when we can
Antonio Sartori78a749f2020-11-30 12:03:394558 // ensure we always have a FrameNavigationEntry here.
4559 if (!previous_frame_entry)
4560 return nullptr;
4561
Titouan Rigoudy6ec70402021-02-02 15:42:194562 const PolicyContainerPolicies* previous_policies =
4563 previous_frame_entry->policy_container_policies();
Antonio Sartori78a749f2020-11-30 12:03:394564
Titouan Rigoudy6ec70402021-02-02 15:42:194565 if (!previous_policies)
Antonio Sartori78a749f2020-11-30 12:03:394566 return nullptr;
4567
4568 // Make a copy of the policy container for the new FrameNavigationEntry.
Titouan Rigoudy72f892d2022-05-02 18:21:234569 return previous_policies->ClonePtr();
Antonio Sartori78a749f2020-11-30 12:03:394570 }
4571
Titouan Rigoudy72f892d2022-05-02 18:21:234572 return rfh->policy_container_host()->policies().ClonePtr();
Antonio Sartori78a749f2020-11-30 12:03:394573}
4574
Hayato Ito2c8c08d02021-06-23 03:38:434575void NavigationControllerImpl::BroadcastHistoryOffsetAndLength() {
Carlos Caballeroede6f8c2021-01-28 11:01:504576 OPTIONAL_TRACE_EVENT2(
Hayato Ito2c8c08d02021-06-23 03:38:434577 "content", "NavigationControllerImpl::BroadcastHistoryOffsetAndLength",
4578 "history_offset", GetLastCommittedEntryIndex(), "history_length",
4579 GetEntryCount());
Carlos Caballeroede6f8c2021-01-28 11:01:504580
4581 auto callback = base::BindRepeating(
4582 [](int history_offset, int history_length, RenderViewHostImpl* rvh) {
4583 if (auto& broadcast = rvh->GetAssociatedPageBroadcast()) {
4584 broadcast->SetHistoryOffsetAndLength(history_offset, history_length);
4585 }
4586 },
Hayato Ito2c8c08d02021-06-23 03:38:434587 GetLastCommittedEntryIndex(), GetEntryCount());
Ali Hijazid87307d2022-11-07 20:15:034588 frame_tree_->root()->render_manager()->ExecutePageBroadcastMethod(callback);
Carlos Caballeroede6f8c2021-01-28 11:01:504589}
4590
4591void NavigationControllerImpl::DidAccessInitialMainDocument() {
4592 // We may have left a failed browser-initiated navigation in the address bar
4593 // to let the user edit it and try again. Clear it now that content might
4594 // show up underneath it.
Ali Hijazid87307d2022-11-07 20:15:034595 if (!frame_tree_->IsLoadingIncludingInnerFrameTrees() && GetPendingEntry())
Carlos Caballeroede6f8c2021-01-28 11:01:504596 DiscardPendingEntry(false);
4597
4598 // Update the URL display.
Abhijeet Kandalkar3dc6e602022-11-09 05:08:374599 delegate_->NotifyNavigationStateChangedFromController(INVALIDATE_TYPE_URL);
Carlos Caballeroede6f8c2021-01-28 11:01:504600}
4601
4602void NavigationControllerImpl::UpdateStateForFrame(
4603 RenderFrameHostImpl* rfhi,
4604 const blink::PageState& page_state) {
Alexander Timinf785f342021-03-18 00:00:564605 OPTIONAL_TRACE_EVENT1("content",
4606 "NavigationControllerImpl::UpdateStateForFrame",
4607 "render_frame_host", rfhi);
Carlos Caballeroede6f8c2021-01-28 11:01:504608 // The state update affects the last NavigationEntry associated with the given
4609 // |render_frame_host|. This may not be the last committed NavigationEntry (as
4610 // in the case of an UpdateState from a frame being swapped out). We track
4611 // which entry this is in the RenderFrameHost's nav_entry_id.
4612 NavigationEntryImpl* entry = GetEntryWithUniqueID(rfhi->nav_entry_id());
4613 if (!entry)
4614 return;
4615
4616 FrameNavigationEntry* frame_entry =
4617 entry->GetFrameEntry(rfhi->frame_tree_node());
4618 if (!frame_entry)
4619 return;
4620
4621 // The SiteInstance might not match if we do a cross-process navigation with
4622 // replacement (e.g., auto-subframe), in which case the swap out of the old
4623 // RenderFrameHost runs in the background after the old FrameNavigationEntry
4624 // has already been replaced and destroyed.
4625 if (frame_entry->site_instance() != rfhi->GetSiteInstance())
4626 return;
4627
4628 if (page_state == frame_entry->page_state())
4629 return; // Nothing to update.
4630
4631 DCHECK(page_state.IsValid()) << "Shouldn't set an empty PageState.";
4632
4633 // The document_sequence_number and item_sequence_number recorded in the
4634 // FrameNavigationEntry should not differ from the one coming with the update,
4635 // since it must come from the same document. Do not update it if a difference
4636 // is detected, as this indicates that |frame_entry| is not the correct one.
4637 blink::ExplodedPageState exploded_state;
4638 if (!blink::DecodePageState(page_state.ToEncodedData(), &exploded_state))
4639 return;
4640
4641 if (exploded_state.top.document_sequence_number !=
4642 frame_entry->document_sequence_number() ||
4643 exploded_state.top.item_sequence_number !=
4644 frame_entry->item_sequence_number()) {
4645 return;
4646 }
4647
4648 frame_entry->SetPageState(page_state);
4649 NotifyEntryChanged(entry);
4650}
4651
Nate Chapina2c881f52023-11-07 17:02:094652namespace {
4653
4654// The caller is responsible for ensuring the entry is same-origin to the
4655// origin to be committed.
4656blink::mojom::NavigationApiHistoryEntryPtr ToNavigationApiHistoryEntry(
4657 FrameNavigationEntry* frame_entry,
4658 int64_t pending_document_sequence_number) {
4659 blink::ExplodedPageState exploded_state;
4660 if (!blink::DecodePageState(frame_entry->page_state().ToEncodedData(),
4661 &exploded_state)) {
4662 return nullptr;
4663 }
4664 blink::ExplodedFrameState frame_state = exploded_state.top;
4665
4666 // If the document represented by this FNE hid its full url from appearing in
4667 // a referrer via a "no-referrer" or "origin" referrer policy, censor the url
4668 // in the navigation API as well (unless we're navigating to that document).
4669 std::u16string url;
4670 if (pending_document_sequence_number ==
4671 frame_entry->document_sequence_number() ||
4672 !frame_entry->protect_url_in_navigation_api()) {
4673 url = frame_state.url_string.value_or(std::u16string());
4674 }
4675
4676 return blink::mojom::NavigationApiHistoryEntry::New(
4677 frame_state.navigation_api_key.value_or(std::u16string()),
4678 frame_state.navigation_api_id.value_or(std::u16string()), url,
4679 frame_state.item_sequence_number, frame_state.document_sequence_number,
4680 frame_state.navigation_api_state);
4681}
4682
4683} // namespace
4684
Domenic Denicolacd30f5f82022-03-16 21:48:014685std::vector<blink::mojom::NavigationApiHistoryEntryPtr>
4686NavigationControllerImpl::PopulateSingleNavigationApiHistoryEntryVector(
Nate Chapind1fe3612021-04-16 20:45:574687 Direction direction,
4688 int entry_index,
4689 const url::Origin& pending_origin,
4690 FrameTreeNode* node,
4691 SiteInstance* site_instance,
Nate Chapin63db0d12022-01-20 22:03:304692 int64_t pending_item_sequence_number,
Nate Chapina2c881f52023-11-07 17:02:094693 int64_t pending_document_sequence_number,
4694 int& last_index_checked) {
Domenic Denicolacd30f5f82022-03-16 21:48:014695 std::vector<blink::mojom::NavigationApiHistoryEntryPtr> entries;
Rakina Zata Amnie2d31312022-11-18 03:38:454696 if (GetLastCommittedEntry()->IsInitialEntry()) {
Rakina Zata Amniafd3c6582021-11-30 06:19:174697 // Don't process the initial entry.
4698 DCHECK_EQ(GetEntryCount(), 1);
4699 return entries;
4700 }
Nate Chapind1fe3612021-04-16 20:45:574701 int offset = direction == Direction::kForward ? 1 : -1;
Nate Chapin63db0d12022-01-20 22:03:304702 int64_t previous_item_sequence_number = pending_item_sequence_number;
Nate Chapind1fe3612021-04-16 20:45:574703 for (int i = entry_index + offset; i >= 0 && i < GetEntryCount();
4704 i += offset) {
Nate Chapina2c881f52023-11-07 17:02:094705 last_index_checked = i;
Nate Chapind1fe3612021-04-16 20:45:574706 FrameNavigationEntry* frame_entry = GetEntryAtIndex(i)->GetFrameEntry(node);
Nate Chapindedfa642022-01-28 23:59:414707 if (!frame_entry)
Nate Chapind1fe3612021-04-16 20:45:574708 break;
Domenic Denicolacd30f5f82022-03-16 21:48:014709 // An entry should only appear in the navigation API entries if it is for
4710 // the same origin as the document being committed. Check the committed
4711 // origin, or if that is not available (during restore), check against the
4712 // FNE's url.
Alison Gale770f3fc2024-04-27 00:39:584713 // TODO(crbug.com/40181982): Move this into ToNavigationApiHistoryEntry()
Nate Chapina2c881f52023-11-07 17:02:094714 // once we can be sure that entries with the same ISN will never be
4715 // cross-origin.
Nate Chapindedfa642022-01-28 23:59:414716 url::Origin frame_entry_origin =
4717 frame_entry->committed_origin().value_or(url::Origin::Resolve(
4718 frame_entry->url(),
4719 frame_entry->initiator_origin().value_or(url::Origin())));
4720 if (!pending_origin.IsSameOriginWith(frame_entry_origin))
Nate Chapind1fe3612021-04-16 20:45:574721 break;
4722 if (previous_item_sequence_number == frame_entry->item_sequence_number())
4723 continue;
Nate Chapina2c881f52023-11-07 17:02:094724 if (blink::mojom::NavigationApiHistoryEntryPtr entry =
4725 ToNavigationApiHistoryEntry(frame_entry,
4726 pending_document_sequence_number)) {
Nate Chapin63db0d12022-01-20 22:03:304727 DCHECK(entry->url.empty() ||
4728 pending_origin.CanBeDerivedFrom(GURL(entry->url)));
Nate Chapind1fe3612021-04-16 20:45:574729 entries.push_back(std::move(entry));
4730 previous_item_sequence_number = frame_entry->item_sequence_number();
4731 }
4732 }
4733 // If |entries| was constructed by iterating backwards from
4734 // |entry_index|, it's latest-at-the-front, but the renderer will want it
4735 // earliest-at-the-front. Reverse it.
4736 if (direction == Direction::kBack)
4737 std::reverse(entries.begin(), entries.end());
4738 return entries;
4739}
4740
Domenic Denicolacd30f5f82022-03-16 21:48:014741blink::mojom::NavigationApiHistoryEntryArraysPtr
4742NavigationControllerImpl::GetNavigationApiHistoryEntryVectors(
Nate Chapin97d2f542022-02-18 01:34:554743 FrameTreeNode* node,
Nate Chapind1fe3612021-04-16 20:45:574744 NavigationRequest* request) {
Rakina Zata Amnic7367852022-11-07 17:10:404745 url::Origin pending_origin = request
Lukasz Anforowicz435e68d2022-11-09 21:47:444746 ? request->GetOriginToCommit().value()
Rakina Zata Amnic7367852022-11-07 17:10:404747 : url::Origin::Create(node->current_url());
Nate Chapind1fe3612021-04-16 20:45:574748
Nate Chapind1fe3612021-04-16 20:45:574749 scoped_refptr<SiteInstance> site_instance =
Nate Chapin97d2f542022-02-18 01:34:554750 node->current_frame_host()->GetSiteInstance();
Nate Chapind1fe3612021-04-16 20:45:574751
Nate Chapine82339d02022-05-03 23:48:254752 // NOTE: |entry_index| is the index where this entry will commit if no
4753 // modifications are made between now and DidCommitNavigation. This is used to
4754 // walk |entries_| and determine which entries should be exposed by the
4755 // navigation API. It is important to calculate this correctly, because blink
4756 // will cancel a same-document history commit if it's not present in the
4757 // entries blink knows about.
4758 int entry_index = GetLastCommittedEntryIndex();
Nate Chapind1fe3612021-04-16 20:45:574759 int64_t pending_item_sequence_number = 0;
Nate Chapin63db0d12022-01-20 22:03:304760 int64_t pending_document_sequence_number = 0;
Nate Chapine82339d02022-05-03 23:48:254761 bool will_create_new_entry = false;
4762 if (GetPendingEntryIndex() != -1) {
4763 entry_index = GetPendingEntryIndex();
4764 if (auto* frame_entry = GetPendingEntry()->GetFrameEntry(node)) {
4765 pending_item_sequence_number = frame_entry->item_sequence_number();
4766 pending_document_sequence_number =
4767 frame_entry->document_sequence_number();
4768 }
4769 } else if (request &&
4770 !NavigationTypeUtils::IsReload(
4771 request->common_params().navigation_type) &&
4772 !NavigationTypeUtils::IsHistory(
4773 request->common_params().navigation_type) &&
4774 !request->common_params().should_replace_current_entry &&
4775 !request->common_params()
4776 .is_history_navigation_in_new_child_frame) {
4777 will_create_new_entry = true;
4778 entry_index = GetLastCommittedEntryIndex() + 1;
4779 // Don't set pending_item_sequence_number or
4780 // pending_document_sequence_number in this case - a new unique isn/dsn will
4781 // be calculated in the renderer later.
4782 } else if (GetLastCommittedEntryIndex() != -1) {
4783 entry_index = GetLastCommittedEntryIndex();
4784 if (auto* frame_entry = GetLastCommittedEntry()->GetFrameEntry(node)) {
Nate Chapind1fe3612021-04-16 20:45:574785 pending_item_sequence_number = frame_entry->item_sequence_number();
Nate Chapin63db0d12022-01-20 22:03:304786 pending_document_sequence_number =
4787 frame_entry->document_sequence_number();
4788 }
Nate Chapind1fe3612021-04-16 20:45:574789 }
4790
Domenic Denicolacd30f5f82022-03-16 21:48:014791 auto entry_arrays = blink::mojom::NavigationApiHistoryEntryArrays::New();
Nate Chapine82339d02022-05-03 23:48:254792 if (entry_index == -1) {
4793 // TODO(rakina): Exit early when there is no last committed entry.
4794 // Remove when InitialNavigationEntry ships.
4795 return entry_arrays;
4796 }
4797
Nate Chapina2c881f52023-11-07 17:02:094798 int backmost_index = entry_index;
Domenic Denicolacd30f5f82022-03-16 21:48:014799 entry_arrays->back_entries = PopulateSingleNavigationApiHistoryEntryVector(
Nate Chapind1fe3612021-04-16 20:45:574800 Direction::kBack, entry_index, pending_origin, node, site_instance.get(),
Nate Chapina2c881f52023-11-07 17:02:094801 pending_item_sequence_number, pending_document_sequence_number,
4802 backmost_index);
Nate Chapind1fe3612021-04-16 20:45:574803
4804 // Don't populate forward entries if they will be truncated by a new entry.
Nate Chapina2c881f52023-11-07 17:02:094805 int forwardmost_index = entry_index;
Nate Chapind1fe3612021-04-16 20:45:574806 if (!will_create_new_entry) {
Domenic Denicolacd30f5f82022-03-16 21:48:014807 entry_arrays->forward_entries =
4808 PopulateSingleNavigationApiHistoryEntryVector(
4809 Direction::kForward, entry_index, pending_origin, node,
4810 site_instance.get(), pending_item_sequence_number,
Nate Chapina2c881f52023-11-07 17:02:094811 pending_document_sequence_number, forwardmost_index);
4812 }
4813
4814 // If the previous entry is within the block of contiguous entries being
4815 // provided, then report it as the `previous_entry`.
Nate Chapinc06cf80a2023-11-18 01:12:254816 FrameNavigationEntry* previous_entry = nullptr;
4817 if (frame_tree_->is_prerendering()) {
4818 int initiator_id = PrerenderHost::GetFromFrameTreeNode(*node)
4819 .initiator_frame_tree_node_id();
4820 if (initiator_id != RenderFrameHost::kNoFrameTreeNodeId) {
4821 auto* initiator_node = FrameTreeNode::GloballyFindByID(initiator_id);
4822 previous_entry = initiator_node->frame_tree()
4823 .controller()
4824 .GetLastCommittedEntry()
4825 ->GetFrameEntry(initiator_node);
4826 }
4827 } else if (GetLastCommittedEntryIndex() != -1 &&
4828 GetLastCommittedEntryIndex() >= backmost_index &&
4829 GetLastCommittedEntryIndex() <= forwardmost_index) {
4830 previous_entry = GetLastCommittedEntry()->GetFrameEntry(node);
4831 }
4832 if (previous_entry) {
4833 url::Origin previous_entry_origin =
4834 previous_entry->committed_origin().value_or(url::Origin::Resolve(
4835 previous_entry->url(),
4836 previous_entry->initiator_origin().value_or(url::Origin())));
Alison Gale770f3fc2024-04-27 00:39:584837 // TODO(crbug.com/40181982): Move this into ToNavigationApiHistoryEntry()
Nate Chapinc06cf80a2023-11-18 01:12:254838 // once we can be sure that entries with the same ISN will never be
4839 // cross-origin.
4840 if (pending_origin.IsSameOriginWith(previous_entry_origin)) {
4841 entry_arrays->previous_entry = ToNavigationApiHistoryEntry(
4842 previous_entry, pending_document_sequence_number);
Nate Chapina2c881f52023-11-07 17:02:094843 }
Nate Chapind1fe3612021-04-16 20:45:574844 }
Nate Chapinc06cf80a2023-11-18 01:12:254845
Nate Chapin4e657a472022-02-06 03:38:374846 return entry_arrays;
Nate Chapind1fe3612021-04-16 20:45:574847}
4848
Nate Chapinfbfe5af2021-06-10 17:22:084849NavigationControllerImpl::HistoryNavigationAction
Domenic Denicolacc094fb2022-03-16 23:40:574850NavigationControllerImpl::ShouldNavigateToEntryForNavigationApiKey(
Nate Chapinfbfe5af2021-06-10 17:22:084851 FrameNavigationEntry* current_entry,
4852 FrameNavigationEntry* target_entry,
Domenic Denicolacc094fb2022-03-16 23:40:574853 const std::string& navigation_api_key) {
Nate Chapinfbfe5af2021-06-10 17:22:084854 if (!target_entry || !target_entry->committed_origin())
4855 return HistoryNavigationAction::kStopLooking;
Nate Chapinfbfe5af2021-06-10 17:22:084856 if (!current_entry->committed_origin()->IsSameOriginWith(
4857 *target_entry->committed_origin())) {
4858 return HistoryNavigationAction::kStopLooking;
4859 }
4860
4861 // NOTE: We don't actually care between kSameDocument and
4862 // kDifferentDocument, so always use kDifferentDocument by convention.
Domenic Denicolacc094fb2022-03-16 23:40:574863 if (target_entry->navigation_api_key() == navigation_api_key)
Nate Chapinfbfe5af2021-06-10 17:22:084864 return HistoryNavigationAction::kDifferentDocument;
4865 return HistoryNavigationAction::kKeepLooking;
4866}
4867
Domenic Denicolacc094fb2022-03-16 23:40:574868void NavigationControllerImpl::NavigateToNavigationApiKey(
Nate Chapinbf682fa32022-09-26 22:41:204869 RenderFrameHostImpl* initiator_rfh,
Arthur Sonzognic686e8f2024-01-11 08:36:374870 std::optional<blink::scheduler::TaskAttributionId>
Yoav Weissa7449c3b2022-11-22 15:15:144871 soft_navigation_heuristics_task_id,
Domenic Denicolacc094fb2022-03-16 23:40:574872 const std::string& key) {
Nate Chapinbf682fa32022-09-26 22:41:204873 FrameTreeNode* node = initiator_rfh->frame_tree_node();
Nate Chapinfbfe5af2021-06-10 17:22:084874 FrameNavigationEntry* current_entry =
4875 GetLastCommittedEntry()->GetFrameEntry(node);
4876 if (!current_entry)
4877 return;
4878
Alison Gale47d1537d2024-04-19 21:31:464879 // TODO(crbug.com/40878000): Make sure that the right task ID is passed
Yoav Weiss8c573952022-11-17 17:35:134880 // when `navigation.traverseTo()` is called.
4881
Nate Chapinfbfe5af2021-06-10 17:22:084882 // We want to find the nearest matching entry that is contiguously
4883 // same-instance and same-origin. Check back first, then forward.
4884 // TODO(japhet): Link spec here once it exists.
4885 for (int i = GetCurrentEntryIndex() - 1; i >= 0; i--) {
Domenic Denicolacc094fb2022-03-16 23:40:574886 auto result = ShouldNavigateToEntryForNavigationApiKey(
Nate Chapinfbfe5af2021-06-10 17:22:084887 current_entry, GetEntryAtIndex(i)->GetFrameEntry(node), key);
4888 if (result == HistoryNavigationAction::kStopLooking)
4889 break;
4890 if (result != HistoryNavigationAction::kKeepLooking) {
Yoav Weissa7449c3b2022-11-22 15:15:144891 GoToIndex(i, initiator_rfh, soft_navigation_heuristics_task_id, &key);
Nate Chapinfbfe5af2021-06-10 17:22:084892 return;
4893 }
4894 }
4895 for (int i = GetCurrentEntryIndex() + 1; i < GetEntryCount(); i++) {
Domenic Denicolacc094fb2022-03-16 23:40:574896 auto result = ShouldNavigateToEntryForNavigationApiKey(
Nate Chapinfbfe5af2021-06-10 17:22:084897 current_entry, GetEntryAtIndex(i)->GetFrameEntry(node), key);
4898 if (result == HistoryNavigationAction::kStopLooking)
4899 break;
4900 if (result != HistoryNavigationAction::kKeepLooking) {
Yoav Weissa7449c3b2022-11-22 15:15:144901 GoToIndex(i, initiator_rfh, soft_navigation_heuristics_task_id, &key);
Nate Chapinfbfe5af2021-06-10 17:22:084902 return;
4903 }
4904 }
Nate Chapinbf682fa32022-09-26 22:41:204905
4906 // If we fall through to here, a matching NavigationEntry couldn't be found.
4907 // Notify the renderer that the navigation was cancelled.
4908 initiator_rfh->GetAssociatedLocalFrame()->TraverseCancelled(
4909 key, blink::mojom::TraverseCancelledReason::kNotFound);
Nate Chapinfbfe5af2021-06-10 17:22:084910}
4911
Domenic Denicolacc094fb2022-03-16 23:40:574912bool NavigationControllerImpl::ShouldProtectUrlInNavigationApi(
Nate Chapin63db0d12022-01-20 22:03:304913 network::mojom::ReferrerPolicy referrer_policy) {
4914 return referrer_policy == network::mojom::ReferrerPolicy::kNever ||
4915 referrer_policy == network::mojom::ReferrerPolicy::kOrigin;
4916}
4917
shivanigithubf405bf0d2021-11-05 17:58:334918bool NavigationControllerImpl::ShouldMaintainTrivialSessionHistory(
4919 const FrameTreeNode* frame_tree_node) const {
Alison Gale81f4f2c72024-04-22 19:33:314920 // TODO(crbug.com/40176906): We may have to add portals in addition to
shivanigithubf405bf0d2021-11-05 17:58:334921 // prerender and fenced frames. This should be kept in sync with
Hayato Ito7a80db42021-07-05 06:18:544922 // LocalFrame version, LocalFrame::ShouldMaintainTrivialSessionHistory.
Takashi Toyoshima4dad2c12023-11-13 10:04:464923 // The preview mode appears as prerendered page in renderers, and
4924 // GetDocument()->IsPrerendering() covers the case together.
Ali Hijazid87307d2022-11-07 20:15:034925 return frame_tree_->is_prerendering() ||
Takashi Toyoshima8dfc05c2024-01-29 21:03:514926 frame_tree_->page_delegate()->IsPageInPreviewMode() ||
shivanigithubf405bf0d2021-11-05 17:58:334927 frame_tree_node->IsInFencedFrameTree();
Hayato Ito7a80db42021-07-05 06:18:544928}
4929
Julie Jeongeun Kim0e242242022-11-30 10:45:094930void NavigationControllerImpl::DidChangeReferrerPolicy(
4931 FrameTreeNode* node,
4932 network::mojom::ReferrerPolicy referrer_policy) {
4933 FrameNavigationEntry* entry = GetLastCommittedEntry()->GetFrameEntry(node);
4934 if (!entry)
4935 return;
4936
4937 // The FrameNavigationEntry may want to change whether to protect its url
4938 // in the navigation API when the referrer policy changes.
4939 entry->set_protect_url_in_navigation_api(
4940 ShouldProtectUrlInNavigationApi(referrer_policy));
4941}
4942
[email protected]8ff00d72012-10-23 19:12:214943} // namespace content