blob: a4b876f9f21bf91b76eb8d74d34467a93e0793e5 [file] [log] [blame]
Avi Drissman4e1b7bc32022-09-15 14:03:501// Copyright 2021 The Chromium Authors
Sreeja Kamishetty9e1d0e732021-05-27 18:20:092// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#include "content/browser/renderer_host/page_impl.h"
6
Matt Falkenhagenf78c2192021-07-24 02:01:437#include "base/barrier_closure.h"
Sky Malice3774b002022-10-21 19:18:408#include "base/feature_list.h"
Dominic Farolino5c606c12021-12-18 09:40:149#include "base/i18n/character_encoding.h"
Lingqi Chidcf722442021-09-02 01:47:1910#include "base/trace_event/optional_trace_event.h"
Sky Malice3774b002022-10-21 19:18:4011#include "cc/base/features.h"
Jeremy Roman4bd173d2021-06-17 00:05:4412#include "content/browser/manifest/manifest_manager_host.h"
Dave Tapuska9c9afe82021-06-22 19:07:4513#include "content/browser/renderer_host/frame_tree_node.h"
Jeremy Roman2d8dfe132021-07-06 20:51:2614#include "content/browser/renderer_host/page_delegate.h"
Julie Jeongeun Kim9e204512021-06-24 07:28:5415#include "content/browser/renderer_host/render_frame_host_delegate.h"
Sreeja Kamishetty9e1d0e732021-05-27 18:20:0916#include "content/browser/renderer_host/render_frame_host_impl.h"
Lingqi Chidcf722442021-09-02 01:47:1917#include "content/browser/renderer_host/render_frame_proxy_host.h"
Jeremy Roman2d8dfe132021-07-06 20:51:2618#include "content/browser/renderer_host/render_view_host_delegate.h"
Matt Falkenhagenf78c2192021-07-24 02:01:4319#include "content/browser/renderer_host/render_view_host_impl.h"
Jeremy Roman2d8dfe132021-07-06 20:51:2620#include "content/public/browser/render_view_host.h"
Camillia Smith Barnesddaf5b12023-01-24 00:06:3221#include "third_party/blink/public/common/features.h"
Sreeja Kamishetty0be3b1b2021-08-12 17:04:1522#include "third_party/blink/public/common/loader/loader_constants.h"
Julie Jeongeun Kim33ef6a22022-03-22 09:46:1123#include "third_party/blink/public/mojom/manifest/manifest.mojom.h"
Jeremy Roman2d8dfe132021-07-06 20:51:2624#include "third_party/perfetto/include/perfetto/tracing/traced_value.h"
Sreeja Kamishetty9e1d0e732021-05-27 18:20:0925
26namespace content {
Jeremy Roman2d8dfe132021-07-06 20:51:2627
28PageImpl::PageImpl(RenderFrameHostImpl& rfh, PageDelegate& delegate)
Lingqi Chidcf722442021-09-02 01:47:1929 : main_document_(rfh),
30 delegate_(delegate),
Camillia Smith Barnesddaf5b12023-01-24 00:06:3231 text_autosizer_page_info_({0, 0, 1.f}) {
32 if (base::FeatureList::IsEnabled(
33 blink::features::kSharedStorageReportEventLimit)) {
34 select_url_report_event_budget_ = static_cast<double>(
35 blink::features::kSharedStorageReportEventBitBudgetPerPageLoad.Get());
36 }
37}
Sreeja Kamishetty9e1d0e732021-05-27 18:20:0938
Sreeja Kamishetty1b5c1432021-06-25 11:32:5939PageImpl::~PageImpl() {
40 // As SupportsUserData is a base class of PageImpl, Page members will be
41 // destroyed before running ~SupportsUserData, which would delete the
42 // associated PageUserData objects. Avoid this by calling ClearAllUserData
43 // explicitly here to ensure that the PageUserData destructors can access
44 // associated Page object.
45 ClearAllUserData();
46}
Sreeja Kamishetty9e1d0e732021-05-27 18:20:0947
Julie Jeongeun Kim9e204512021-06-24 07:28:5448const absl::optional<GURL>& PageImpl::GetManifestUrl() const {
Sreeja Kamishetty7c91ab22021-06-03 13:29:5249 return manifest_url_;
50}
51
Jeremy Roman4bd173d2021-06-17 00:05:4452void PageImpl::GetManifest(GetManifestCallback callback) {
53 ManifestManagerHost* manifest_manager_host =
Julie Jeongeun Kim33ef6a22022-03-22 09:46:1154 ManifestManagerHost::GetOrCreateForPage(*this);
Jeremy Roman4bd173d2021-06-17 00:05:4455 manifest_manager_host->GetManifest(std::move(callback));
56}
57
Julie Jeongeun Kimda529922023-01-13 02:59:5958bool PageImpl::IsPrimary() const {
Dominic Farolino4bc10ee2021-08-31 00:37:3659 // TODO(1244137): Check for portals as well, once they are migrated to MPArch.
Ali Hijazid87307d2022-11-07 20:15:0360 if (main_document_->IsFencedFrameRoot())
Dominic Farolino4bc10ee2021-08-31 00:37:3661 return false;
62
Ali Hijazid87307d2022-11-07 20:15:0363 return main_document_->lifecycle_state() ==
Khushalc5eaf222021-06-30 20:15:4864 RenderFrameHostImpl::LifecycleStateImpl::kActive;
Dave Tapuska9c9afe82021-06-22 19:07:4565}
66
Julie Jeongeun Kim9e204512021-06-24 07:28:5467void PageImpl::UpdateManifestUrl(const GURL& manifest_url) {
68 manifest_url_ = manifest_url;
69
70 // If |main_document_| is not active, the notification is sent on the page
71 // activation.
Ali Hijazid87307d2022-11-07 20:15:0372 if (!main_document_->IsActive())
Julie Jeongeun Kim9e204512021-06-24 07:28:5473 return;
74
Ali Hijazid87307d2022-11-07 20:15:0375 main_document_->delegate()->OnManifestUrlChanged(*this);
Julie Jeongeun Kim9e204512021-06-24 07:28:5476}
77
Jeremy Roman2d8dfe132021-07-06 20:51:2678void PageImpl::WriteIntoTrace(perfetto::TracedValue context) {
79 auto dict = std::move(context).WriteDictionary();
Ali Hijazid87307d2022-11-07 20:15:0380 dict.Add("main_document", *main_document_);
Jeremy Roman2d8dfe132021-07-06 20:51:2681}
82
Miyoung Shinfa182e472021-09-03 12:39:3283base::WeakPtr<Page> PageImpl::GetWeakPtr() {
84 return weak_factory_.GetWeakPtr();
85}
86
Yao Xiaoc7224362022-02-16 08:21:4087base::WeakPtr<PageImpl> PageImpl::GetWeakPtrImpl() {
88 return weak_factory_.GetWeakPtr();
89}
90
Kevin McNee3183a7792021-11-09 21:03:3691bool PageImpl::IsPageScaleFactorOne() {
Kevin McNeec4325ba2022-04-08 23:18:2392 return GetPageScaleFactor() == 1.f;
Kevin McNee3183a7792021-11-09 21:03:3693}
94
Jeremy Roman2d8dfe132021-07-06 20:51:2695void PageImpl::OnFirstVisuallyNonEmptyPaint() {
96 did_first_visually_non_empty_paint_ = true;
Ali Hijazid87307d2022-11-07 20:15:0397 delegate_->OnFirstVisuallyNonEmptyPaint(*this);
Jeremy Roman2d8dfe132021-07-06 20:51:2698}
99
100void PageImpl::OnThemeColorChanged(const absl::optional<SkColor>& theme_color) {
101 main_document_theme_color_ = theme_color;
Ali Hijazid87307d2022-11-07 20:15:03102 delegate_->OnThemeColorChanged(*this);
Jeremy Roman2d8dfe132021-07-06 20:51:26103}
104
105void PageImpl::DidChangeBackgroundColor(SkColor background_color,
106 bool color_adjust) {
107 main_document_background_color_ = background_color;
Ali Hijazid87307d2022-11-07 20:15:03108 delegate_->OnBackgroundColorChanged(*this);
Jeremy Roman2d8dfe132021-07-06 20:51:26109 if (color_adjust) {
110 // <meta name="color-scheme" content="dark"> may pass the dark canvas
111 // background before the first paint in order to avoid flashing the white
112 // background in between loading documents. If we perform a navigation
113 // within the same renderer process, we keep the content background from the
114 // previous page while rendering is blocked in the new page, but for cross
115 // process navigations we would paint the default background (typically
116 // white) while the rendering is blocked.
Ali Hijazid87307d2022-11-07 20:15:03117 main_document_->GetRenderWidgetHost()->GetView()->SetContentBackgroundColor(
Jeremy Roman2d8dfe132021-07-06 20:51:26118 background_color);
119 }
120}
121
Michael Bai19f17a302021-12-08 04:08:33122void PageImpl::DidInferColorScheme(
123 blink::mojom::PreferredColorScheme color_scheme) {
124 main_document_inferred_color_scheme_ = color_scheme;
Ali Hijazid87307d2022-11-07 20:15:03125 delegate_->DidInferColorScheme(*this);
Michael Bai19f17a302021-12-08 04:08:33126}
127
Julie Jeongeun Kimd4597df12022-11-11 02:44:51128void PageImpl::NotifyPageBecameCurrent() {
129 if (!IsPrimary())
130 return;
131 delegate_->NotifyPageBecamePrimary(*this);
132}
133
Jeremy Roman2d8dfe132021-07-06 20:51:26134void PageImpl::SetContentsMimeType(std::string mime_type) {
135 contents_mime_type_ = std::move(mime_type);
136}
137
Lingqi Chidcf722442021-09-02 01:47:19138void PageImpl::OnTextAutosizerPageInfoChanged(
139 blink::mojom::TextAutosizerPageInfoPtr page_info) {
140 OPTIONAL_TRACE_EVENT0("content", "PageImpl::OnTextAutosizerPageInfoChanged");
141
Dave Tapuska2cf1f532022-08-10 15:30:49142 // Keep a copy of `page_info` in case we create a new `blink::WebView` before
143 // the next update, so that the PageImpl can tell the newly created
144 // `blink::WebView` about the autosizer info.
Lingqi Chidcf722442021-09-02 01:47:19145 text_autosizer_page_info_.main_frame_width = page_info->main_frame_width;
146 text_autosizer_page_info_.main_frame_layout_width =
147 page_info->main_frame_layout_width;
148 text_autosizer_page_info_.device_scale_adjustment =
149 page_info->device_scale_adjustment;
150
151 auto remote_frames_broadcast_callback = base::BindRepeating(
152 [](const blink::mojom::TextAutosizerPageInfo& page_info,
153 RenderFrameProxyHost* proxy_host) {
154 DCHECK(proxy_host);
155 proxy_host->GetAssociatedRemoteMainFrame()->UpdateTextAutosizerPageInfo(
156 page_info.Clone());
157 },
158 text_autosizer_page_info_);
159
Ali Hijazid87307d2022-11-07 20:15:03160 main_document_->frame_tree()
Lingqi Chidcf722442021-09-02 01:47:19161 ->root()
162 ->render_manager()
163 ->ExecuteRemoteFramesBroadcastMethod(
164 std::move(remote_frames_broadcast_callback),
Ali Hijazid87307d2022-11-07 20:15:03165 main_document_->GetSiteInstance());
Lingqi Chidcf722442021-09-02 01:47:19166}
167
Matt Falkenhagenf78c2192021-07-24 02:01:43168void PageImpl::SetActivationStartTime(base::TimeTicks activation_start) {
169 DCHECK(!activation_start_time_for_prerendering_);
170 activation_start_time_for_prerendering_ = activation_start;
171}
172
173void PageImpl::ActivateForPrerendering(
Vladimir Levin48d51002023-02-27 17:23:27174 StoredPage::RenderViewHostImplSafeRefSet& render_view_hosts,
175 absl::optional<blink::ViewTransitionState> view_transition_state) {
Matt Falkenhagenf78c2192021-07-24 02:01:43176 base::OnceClosure did_activate_render_views =
177 base::BindOnce(&PageImpl::DidActivateAllRenderViewsForPrerendering,
178 weak_factory_.GetWeakPtr());
179
180 base::RepeatingClosure barrier = base::BarrierClosure(
181 render_view_hosts.size(), std::move(did_activate_render_views));
Dave Tapuskac3e58352022-09-28 19:05:27182 for (const auto& rvh : render_view_hosts) {
Vladimir Levin48d51002023-02-27 17:23:27183 auto params = blink::mojom::PrerenderPageActivationParams::New();
184
Matt Falkenhagenf78c2192021-07-24 02:01:43185 // Only send navigation_start to the RenderViewHost for the main frame to
186 // avoid sending the info cross-origin. Only this RenderViewHost needs the
187 // info, as we expect the other RenderViewHosts are made for cross-origin
188 // iframes which have not yet loaded their document. To the renderer, it
189 // just looks like an ongoing navigation is happening in the frame and has
190 // not yet committed. These RenderViews still need to know about activation
191 // so their documents are created in the non-prerendered state once their
192 // navigation is committed.
Vladimir Levin48d51002023-02-27 17:23:27193 if (main_document_->GetRenderViewHost() == &*rvh) {
194 params->activation_start = *activation_start_time_for_prerendering_;
195 params->view_transition_state = std::move(view_transition_state);
196 }
Matt Falkenhagenf78c2192021-07-24 02:01:43197
Hiroki Nakagawaab53cd22022-04-13 19:18:02198 params->was_user_activated =
Ali Hijazid87307d2022-11-07 20:15:03199 main_document_->frame_tree_node()
200 ->has_received_user_gesture_before_nav()
Hiroki Nakagawaab53cd22022-04-13 19:18:02201 ? blink::mojom::WasActivatedOption::kYes
202 : blink::mojom::WasActivatedOption::kNo;
Hiroki Nakagawaab53cd22022-04-13 19:18:02203 rvh->ActivatePrerenderedPage(std::move(params), barrier);
Matt Falkenhagenf78c2192021-07-24 02:01:43204 }
205
206 // Prepare each RenderFrameHostImpl in this Page for activation.
207 // TODO(https://crbug.com/1232528): Currently we check GetPage() below because
208 // RenderFrameHostImpls may be in a different Page, if, e.g., they are in an
209 // inner WebContents. These are in a different FrameTree which might not know
210 // it is being prerendered. We should teach these FrameTrees that they are
211 // being prerendered, or ban inner FrameTrees in a prerendering page.
Ali Hijazid87307d2022-11-07 20:15:03212 main_document_->ForEachRenderFrameHostIncludingSpeculative(
Daniel Cheng982f2b22022-08-25 23:46:16213 [this](RenderFrameHostImpl* rfh) {
214 if (&rfh->GetPage() != this)
Matt Falkenhagenf78c2192021-07-24 02:01:43215 return;
216 rfh->RendererWillActivateForPrerendering();
Daniel Cheng982f2b22022-08-25 23:46:16217 });
Matt Falkenhagenf78c2192021-07-24 02:01:43218}
219
Sreeja Kamishetty81fbeefb2021-08-12 07:21:41220void PageImpl::MaybeDispatchLoadEventsOnPrerenderActivation() {
221 DCHECK(IsPrimary());
222
Sreeja Kamishetty0be3b1b2021-08-12 17:04:15223 // Dispatch LoadProgressChanged notification on activation with the
224 // prerender last load progress value if the value is not equal to
225 // blink::kFinalLoadProgress, whose notification is dispatched during call
226 // to DidStopLoading.
227 if (load_progress() != blink::kFinalLoadProgress)
Ali Hijazid87307d2022-11-07 20:15:03228 main_document_->DidChangeLoadProgress(load_progress());
Sreeja Kamishetty0be3b1b2021-08-12 17:04:15229
Sreeja Kamishetty49783302022-01-28 17:52:25230 // Dispatch PrimaryMainDocumentElementAvailable before dispatching following
231 // load complete events.
232 if (is_main_document_element_available())
Ali Hijazid87307d2022-11-07 20:15:03233 main_document_->MainDocumentElementAvailable(uses_temporary_zoom_level());
Sreeja Kamishettycd5560912021-11-22 11:54:53234
Ali Hijazid87307d2022-11-07 20:15:03235 main_document_->ForEachRenderFrameHost(
Daniel Cheng982f2b22022-08-25 23:46:16236 &RenderFrameHostImpl::MaybeDispatchDOMContentLoadedOnPrerenderActivation);
Sreeja Kamishetty81fbeefb2021-08-12 07:21:41237
238 if (is_on_load_completed_in_main_document())
Ali Hijazid87307d2022-11-07 20:15:03239 main_document_->DocumentOnLoadCompleted();
Sreeja Kamishetty81fbeefb2021-08-12 07:21:41240
Ali Hijazid87307d2022-11-07 20:15:03241 main_document_->ForEachRenderFrameHost(
Daniel Cheng982f2b22022-08-25 23:46:16242 &RenderFrameHostImpl::MaybeDispatchDidFinishLoadOnPrerenderActivation);
Sreeja Kamishetty81fbeefb2021-08-12 07:21:41243}
244
Matt Falkenhagenf78c2192021-07-24 02:01:43245void PageImpl::DidActivateAllRenderViewsForPrerendering() {
246 // Tell each RenderFrameHostImpl in this Page that activation finished.
Ali Hijazid87307d2022-11-07 20:15:03247 main_document_->ForEachRenderFrameHost([this](RenderFrameHostImpl* rfh) {
Daniel Cheng982f2b22022-08-25 23:46:16248 if (&rfh->GetPage() != this)
249 return;
250 rfh->RendererDidActivateForPrerendering();
251 });
Matt Falkenhagenf78c2192021-07-24 02:01:43252}
253
Sreeja Kamishetty1b5c1432021-06-25 11:32:59254RenderFrameHost& PageImpl::GetMainDocumentHelper() {
Ali Hijazid87307d2022-11-07 20:15:03255 return *main_document_;
Sreeja Kamishetty1b5c1432021-06-25 11:32:59256}
257
258RenderFrameHostImpl& PageImpl::GetMainDocument() const {
Ali Hijazid87307d2022-11-07 20:15:03259 return *main_document_;
Sreeja Kamishetty1b5c1432021-06-25 11:32:59260}
261
Yoshisato Yanagisawad016d62d32021-10-15 04:38:55262void PageImpl::UpdateBrowserControlsState(cc::BrowserControlsState constraints,
263 cc::BrowserControlsState current,
264 bool animate) {
265 // TODO(https://crbug.com/1154852): Asking for the LocalMainFrame interface
266 // before the RenderFrame is created is racy.
Nasko Oskov8b04f402022-05-26 23:29:56267 if (!GetMainDocument().IsRenderFrameLive())
Yoshisato Yanagisawad016d62d32021-10-15 04:38:55268 return;
269
Sky Malice3774b002022-10-21 19:18:40270 if (base::FeatureList::IsEnabled(
271 features::kUpdateBrowserControlsWithoutProxy)) {
272 GetMainDocument().GetRenderWidgetHost()->UpdateBrowserControlsState(
273 constraints, current, animate);
274 } else {
275 GetMainDocument().GetAssociatedLocalMainFrame()->UpdateBrowserControlsState(
276 constraints, current, animate);
277 }
Yoshisato Yanagisawad016d62d32021-10-15 04:38:55278}
279
Kevin McNeec4325ba2022-04-08 23:18:23280float PageImpl::GetPageScaleFactor() const {
281 return GetMainDocument().GetPageScaleFactor();
282}
283
Dominic Farolino5c606c12021-12-18 09:40:14284void PageImpl::UpdateEncoding(const std::string& encoding_name) {
285 if (encoding_name == last_reported_encoding_)
286 return;
287 last_reported_encoding_ = encoding_name;
288
289 canonical_encoding_ =
290 base::GetCanonicalEncodingNameByAliasName(encoding_name);
291}
292
Yoshisato Yanagisawa8ae0d112022-04-20 01:49:30293void PageImpl::NotifyVirtualKeyboardOverlayRect(
294 const gfx::Rect& keyboard_rect) {
295 // TODO(https://crbug.com/1317002): send notification to outer frames if
296 // needed.
David Bokand6e44055b2022-09-21 03:58:08297 DCHECK_EQ(virtual_keyboard_mode(),
298 ui::mojom::VirtualKeyboardMode::kOverlaysContent);
Yoshisato Yanagisawa8ae0d112022-04-20 01:49:30299 GetMainDocument().GetAssociatedLocalFrame()->NotifyVirtualKeyboardOverlayRect(
300 keyboard_rect);
301}
302
David Bokand6e44055b2022-09-21 03:58:08303void PageImpl::SetVirtualKeyboardMode(ui::mojom::VirtualKeyboardMode mode) {
304 if (virtual_keyboard_mode_ == mode)
305 return;
306
307 virtual_keyboard_mode_ = mode;
308
Ali Hijazid87307d2022-11-07 20:15:03309 delegate_->OnVirtualKeyboardModeChanged(*this);
David Bokand6e44055b2022-09-21 03:58:08310}
311
Yoshisato Yanagisawa668f8442022-04-20 04:45:58312base::flat_map<std::string, std::string> PageImpl::GetKeyboardLayoutMap() {
313 return GetMainDocument().GetRenderWidgetHost()->GetKeyboardLayoutMap();
314}
315
Camillia Smith Barnes574d4d42023-01-10 18:57:47316bool PageImpl::IsSelectURLAllowed(const url::Origin& origin) {
Camillia Smith Barnes9d70e5ae82023-01-18 19:25:24317 if (!base::FeatureList::IsEnabled(
318 blink::features::kSharedStorageSelectURLLimit)) {
319 return true;
320 }
321
Camillia Smith Barnes574d4d42023-01-10 18:57:47322 int& count = select_url_count_[origin];
323 if (count >=
324 blink::features::
325 kSharedStorageMaxAllowedSelectURLCallsPerOriginPerPageLoad.Get()) {
326 return false;
327 }
328
329 ++count;
330 return true;
331}
332
Camillia Smith Barnesddaf5b12023-01-24 00:06:32333bool PageImpl::CheckAndMaybeDebitReportEventForSelectURLBudget(
334 RenderFrameHost& rfh) {
335 if (!select_url_report_event_budget_.has_value()) {
336 // `blink::features::kSharedStorageReportEventLimit` is disabled.
337 return true;
338 }
339
340 std::vector<const SharedStorageBudgetMetadata*> metadata_vector =
341 static_cast<RenderFrameHostImpl&>(rfh)
342 .frame_tree_node()
343 ->FindSharedStorageBudgetMetadata();
344
345 // Get the total charge.
346 double total_to_charge = 0;
347 for (const auto* metadata : metadata_vector) {
348 if (metadata->report_event_called) {
349 // The bits have already been charged for this URN.
350 continue;
351 }
352
353 total_to_charge += metadata->budget_to_charge;
354 }
355
356 if (total_to_charge > select_url_report_event_budget_.value()) {
357 // There is insufficient budget remaining.
358 return false;
359 }
360
361 // Set flag(s) that `reportEvent()` has now been called.
362 for (const auto* metadata : metadata_vector) {
363 if (metadata->report_event_called) {
364 // The bits have already been charged for this URN.
365 continue;
366 }
367
368 metadata->report_event_called = true;
369 }
370
371 // There is sufficient budget, so charge the total now.
372 select_url_report_event_budget_.value() -= total_to_charge;
373 return true;
374}
375
Sreeja Kamishetty9e1d0e732021-05-27 18:20:09376} // namespace content