blob: a11c138314f9a57837f2f66996c52eca88751e3a [file] [log] [blame]
Avi Drissman4e1b7bc32022-09-15 14:03:501// Copyright 2013 The Chromium Authors
danakjc492bf82020-09-09 20:02:442// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CONTENT_BROWSER_RENDERER_HOST_FRAME_TREE_NODE_H_
6#define CONTENT_BROWSER_RENDERER_HOST_FRAME_TREE_NODE_H_
7
8#include <stddef.h>
9
10#include <memory>
11#include <string>
David Sanders2c1194d92022-04-19 23:32:3212#include <utility>
danakjc492bf82020-09-09 20:02:4413
14#include "base/gtest_prod_util.h"
Keishi Hattori0e45c022021-11-27 09:25:5215#include "base/memory/raw_ptr.h"
David Sanders2c1194d92022-04-19 23:32:3216#include "base/memory/scoped_refptr.h"
David Sandersd4bf5eb2022-03-17 07:12:0517#include "base/observer_list.h"
Mingyu Lei7956b8b2023-07-24 08:24:0818#include "base/task/cancelable_task_tracker.h"
Daniel Cheng390e2a72022-09-28 06:07:5319#include "content/browser/renderer_host/navigation_discard_reason.h"
danakjc492bf82020-09-09 20:02:4420#include "content/browser/renderer_host/navigator.h"
21#include "content/browser/renderer_host/render_frame_host_impl.h"
22#include "content/browser/renderer_host/render_frame_host_manager.h"
Miyoung Shin7cf88b42022-11-07 13:22:3023#include "content/browser/renderer_host/render_frame_host_owner.h"
danakjc492bf82020-09-09 20:02:4424#include "content/common/content_export.h"
Julie Jeongeun Kimf38c1eca2021-12-14 07:46:5525#include "content/public/browser/frame_type.h"
danakjc492bf82020-09-09 20:02:4426#include "services/network/public/mojom/content_security_policy.mojom-forward.h"
Julie Jeongeun Kim0e242242022-11-30 10:45:0927#include "services/network/public/mojom/referrer_policy.mojom-forward.h"
Lei Zhang698df03c2021-05-21 04:23:3428#include "third_party/abseil-cpp/absl/types/optional.h"
Kevin McNee43fe8292021-10-04 22:59:4129#include "third_party/blink/public/common/frame/frame_owner_element_type.h"
danakjc492bf82020-09-09 20:02:4430#include "third_party/blink/public/common/frame/frame_policy.h"
danakjc492bf82020-09-09 20:02:4431#include "third_party/blink/public/mojom/frame/frame_owner_properties.mojom.h"
Gyuyoung Kimc16e52e92021-03-19 02:45:3732#include "third_party/blink/public/mojom/frame/frame_replication_state.mojom-forward.h"
Daniel Cheng6ac128172021-05-25 18:49:0133#include "third_party/blink/public/mojom/frame/tree_scope_type.mojom.h"
David Sanders2c1194d92022-04-19 23:32:3234#include "third_party/blink/public/mojom/frame/user_activation_update_types.mojom-forward.h"
Miyoung Shinaf9a34362023-01-31 02:46:5135#include "third_party/blink/public/mojom/webauthn/virtual_authenticator.mojom-forward.h"
danakjc492bf82020-09-09 20:02:4436
Gabriel Charetted87f10f2022-03-31 00:44:2237#include "base/time/time.h"
danakjc492bf82020-09-09 20:02:4438#include "url/gurl.h"
39#include "url/origin.h"
40
41namespace content {
42
43class NavigationRequest;
44class RenderFrameHostImpl;
45class NavigationEntryImpl;
Paul Semel3e241042022-10-11 12:57:3146class FrameTree;
danakjc492bf82020-09-09 20:02:4447
48// When a page contains iframes, its renderer process maintains a tree structure
49// of those frames. We are mirroring this tree in the browser process. This
50// class represents a node in this tree and is a wrapper for all objects that
51// are frame-specific (as opposed to page-specific).
52//
53// Each FrameTreeNode has a current RenderFrameHost, which can change over
54// time as the frame is navigated. Any immediate subframes of the current
55// document are tracked using FrameTreeNodes owned by the current
56// RenderFrameHost, rather than as children of FrameTreeNode itself. This
57// allows subframe FrameTreeNodes to stay alive while a RenderFrameHost is
58// still alive - for example while pending deletion, after a new current
59// RenderFrameHost has replaced it.
Miyoung Shin7cf88b42022-11-07 13:22:3060class CONTENT_EXPORT FrameTreeNode : public RenderFrameHostOwner {
danakjc492bf82020-09-09 20:02:4461 public:
62 class Observer {
63 public:
64 // Invoked when a FrameTreeNode is being destroyed.
65 virtual void OnFrameTreeNodeDestroyed(FrameTreeNode* node) {}
66
67 // Invoked when a FrameTreeNode becomes focused.
68 virtual void OnFrameTreeNodeFocused(FrameTreeNode* node) {}
69
Arthur Hemerye4659282022-03-28 08:36:1570 // Invoked when a FrameTreeNode moves to a different BrowsingInstance and
71 // the popups it opened should be disowned.
72 virtual void OnFrameTreeNodeDisownedOpenee(FrameTreeNode* node) {}
73
Fergal Dalya1d569972021-03-16 03:24:5374 virtual ~Observer() = default;
danakjc492bf82020-09-09 20:02:4475 };
76
77 static const int kFrameTreeNodeInvalidId;
78
79 // Returns the FrameTreeNode with the given global |frame_tree_node_id|,
80 // regardless of which FrameTree it is in.
81 static FrameTreeNode* GloballyFindByID(int frame_tree_node_id);
82
83 // Returns the FrameTreeNode for the given |rfh|. Same as
84 // rfh->frame_tree_node(), but also supports nullptrs.
85 static FrameTreeNode* From(RenderFrameHost* rfh);
86
87 // Callers are are expected to initialize sandbox flags separately after
88 // calling the constructor.
89 FrameTreeNode(
Arthur Sonzognif6785ec2022-12-05 10:11:5090 FrameTree& frame_tree,
danakjc492bf82020-09-09 20:02:4491 RenderFrameHostImpl* parent,
Daniel Cheng6ac128172021-05-25 18:49:0192 blink::mojom::TreeScopeType tree_scope_type,
danakjc492bf82020-09-09 20:02:4493 bool is_created_by_script,
danakjc492bf82020-09-09 20:02:4494 const blink::mojom::FrameOwnerProperties& frame_owner_properties,
Kevin McNee43fe8292021-10-04 22:59:4195 blink::FrameOwnerElementType owner_type,
Dominic Farolino08662c82021-06-11 07:36:3496 const blink::FramePolicy& frame_owner);
danakjc492bf82020-09-09 20:02:4497
Peter Boström828b9022021-09-21 02:28:4398 FrameTreeNode(const FrameTreeNode&) = delete;
99 FrameTreeNode& operator=(const FrameTreeNode&) = delete;
100
Miyoung Shin7cf88b42022-11-07 13:22:30101 ~FrameTreeNode() override;
danakjc492bf82020-09-09 20:02:44102
103 void AddObserver(Observer* observer);
104 void RemoveObserver(Observer* observer);
105
Ian Vollick25a9d032022-04-12 23:20:17106 // Frame trees may be nested so it can be the case that IsMainFrame() is true,
107 // but is not the outermost main frame. In particular, !IsMainFrame() cannot
108 // be used to check if the frame is an embedded frame -- use
109 // !IsOutermostMainFrame() instead. NB: this does not escape guest views;
110 // IsOutermostMainFrame will be true for the outermost main frame in an inner
111 // guest view.
danakjc492bf82020-09-09 20:02:44112 bool IsMainFrame() const;
Arthur Hemerya06697f2023-03-14 09:20:57113 bool IsOutermostMainFrame() const;
danakjc492bf82020-09-09 20:02:44114
arthursonzogni76098e52020-11-25 14:18:45115 // Clears any state in this node which was set by the document itself (CSP &
116 // UserActivationState) and notifies proxies as appropriate. Invoked after
117 // committing navigation to a new document (since the new document comes with
118 // a fresh set of CSP).
119 // TODO(arthursonzogni): Remove this function. The frame/document must not be
120 // left temporarily with lax state.
Hiroki Nakagawaab309622021-05-19 16:38:13121 void ResetForNavigation();
danakjc492bf82020-09-09 20:02:44122
Arthur Sonzognif6785ec2022-12-05 10:11:50123 FrameTree& frame_tree() const { return frame_tree_.get(); }
Paul Semel3e241042022-10-11 12:57:31124 Navigator& navigator();
danakjc492bf82020-09-09 20:02:44125
126 RenderFrameHostManager* render_manager() { return &render_manager_; }
Alexander Timin33e2e2c12022-03-03 04:21:33127 const RenderFrameHostManager* render_manager() const {
128 return &render_manager_;
129 }
danakjc492bf82020-09-09 20:02:44130 int frame_tree_node_id() const { return frame_tree_node_id_; }
Yuzu Saijo03dbf9b2022-07-22 04:29:45131 // This reflects window.name, which is initially set to the the "name"
132 // attribute. But this won't reflect changes of 'name' attribute and instead
133 // reflect changes to the Window object's name property.
134 // This is different from IframeAttributes' name in that this will not get
135 // updated when 'name' attribute gets updated.
Harkiran Bolaria4eacb3a2021-12-13 20:03:47136 const std::string& frame_name() const {
137 return render_manager_.current_replication_state().name;
138 }
danakjc492bf82020-09-09 20:02:44139
140 const std::string& unique_name() const {
Harkiran Bolaria4eacb3a2021-12-13 20:03:47141 return render_manager_.current_replication_state().unique_name;
danakjc492bf82020-09-09 20:02:44142 }
143
danakjc492bf82020-09-09 20:02:44144 size_t child_count() const { return current_frame_host()->child_count(); }
145
danakjc492bf82020-09-09 20:02:44146 RenderFrameHostImpl* parent() const { return parent_; }
147
Dave Tapuskac8de3b02021-12-03 21:51:01148 // See `RenderFrameHost::GetParentOrOuterDocument()` for
149 // documentation.
Arthur Hemerya06697f2023-03-14 09:20:57150 RenderFrameHostImpl* GetParentOrOuterDocument() const;
Dave Tapuskac8de3b02021-12-03 21:51:01151
152 // See `RenderFrameHostImpl::GetParentOrOuterDocumentOrEmbedder()` for
153 // documentation.
154 RenderFrameHostImpl* GetParentOrOuterDocumentOrEmbedder();
155
danakjc492bf82020-09-09 20:02:44156 FrameTreeNode* opener() const { return opener_; }
157
Rakina Zata Amni3a48ae42022-05-05 03:39:56158 FrameTreeNode* first_live_main_frame_in_original_opener_chain() const {
159 return first_live_main_frame_in_original_opener_chain_;
160 }
danakjc492bf82020-09-09 20:02:44161
Anton Bikineevf62d1bf2021-05-15 17:56:07162 const absl::optional<base::UnguessableToken>& opener_devtools_frame_token() {
Wolfgang Beyerd8809db2020-09-30 15:29:39163 return opener_devtools_frame_token_;
164 }
165
Julie Jeongeun Kimf38c1eca2021-12-14 07:46:55166 // Returns the type of the frame. Refer to frame_type.h for the details.
167 FrameType GetFrameType() const;
168
danakjc492bf82020-09-09 20:02:44169 // Assigns a new opener for this node and, if |opener| is non-null, registers
170 // an observer that will clear this node's opener if |opener| is ever
171 // destroyed.
172 void SetOpener(FrameTreeNode* opener);
173
174 // Assigns the initial opener for this node, and if |opener| is non-null,
175 // registers an observer that will clear this node's opener if |opener| is
176 // ever destroyed. The value set here is the root of the tree.
177 //
178 // It is not possible to change the opener once it was set.
179 void SetOriginalOpener(FrameTreeNode* opener);
180
Wolfgang Beyerd8809db2020-09-30 15:29:39181 // Assigns an opener frame id for this node. This string id is only set once
182 // and cannot be changed. It persists, even if the |opener| is destroyed. It
183 // is used for attribution in the DevTools frontend.
184 void SetOpenerDevtoolsFrameToken(
185 base::UnguessableToken opener_devtools_frame_token);
186
danakjc492bf82020-09-09 20:02:44187 FrameTreeNode* child_at(size_t index) const {
188 return current_frame_host()->child_at(index);
189 }
190
191 // Returns the URL of the last committed page in the current frame.
192 const GURL& current_url() const {
193 return current_frame_host()->GetLastCommittedURL();
194 }
195
Abhijeet Kandalkarb86993b2022-11-22 05:17:40196 // Note that the current RenderFrameHost might not exist yet when calling this
197 // during FrameTreeNode initialization. In this case the FrameTreeNode must be
198 // on the initial empty document. Refer RFHI::is_initial_empty_document for a
199 // more details.
Rakina Zata Amni86c88fa2021-11-01 01:27:30200 bool is_on_initial_empty_document() const {
Abhijeet Kandalkarb86993b2022-11-22 05:17:40201 return current_frame_host()
202 ? current_frame_host()->is_initial_empty_document()
203 : true;
Rakina Zata Amnifc4cc3d42021-06-10 09:03:56204 }
205
danakjc492bf82020-09-09 20:02:44206 // Returns whether the frame's owner element in the parent document is
207 // collapsed, that is, removed from the layout as if it did not exist, as per
208 // request by the embedder (of the content/ layer).
209 bool is_collapsed() const { return is_collapsed_; }
210
211 // Sets whether to collapse the frame's owner element in the parent document,
212 // that is, to remove it from the layout as if it did not exist, as per
213 // request by the embedder (of the content/ layer). Cannot be called for main
214 // frames.
215 //
216 // This only has an effect for <iframe> owner elements, and is a no-op when
217 // called on sub-frames hosted in <frame>, <object>, and <embed> elements.
218 void SetCollapsed(bool collapsed);
219
220 // Returns the origin of the last committed page in this frame.
221 // WARNING: To get the last committed origin for a particular
222 // RenderFrameHost, use RenderFrameHost::GetLastCommittedOrigin() instead,
223 // which will behave correctly even when the RenderFrameHost is not the
224 // current one for this frame (such as when it's pending deletion).
225 const url::Origin& current_origin() const {
Harkiran Bolaria4eacb3a2021-12-13 20:03:47226 return render_manager_.current_replication_state().origin;
danakjc492bf82020-09-09 20:02:44227 }
228
danakjc492bf82020-09-09 20:02:44229 // Returns the latest frame policy (sandbox flags and container policy) for
230 // this frame. This includes flags inherited from parent frames and the latest
231 // flags from the <iframe> element hosting this frame. The returned policies
232 // may not yet have taken effect, since "sandbox" and "allow" attribute
Liam Brady25a14162022-12-02 15:25:57233 // updates in an <iframe> element take effect on next navigation. For
234 // <fencedframe> elements, not everything in the frame policy might actually
235 // take effect after the navigation. To retrieve the currently active policy
236 // for this frame, use effective_frame_policy().
danakjc492bf82020-09-09 20:02:44237 const blink::FramePolicy& pending_frame_policy() const {
238 return pending_frame_policy_;
239 }
240
241 // Update this frame's sandbox flags and container policy. This is called
242 // when a parent frame updates the "sandbox" attribute in the <iframe> element
243 // for this frame, or any of the attributes which affect the container policy
244 // ("allowfullscreen", "allowpaymentrequest", "allow", and "src".)
245 // These policies won't take effect until next navigation. If this frame's
246 // parent is itself sandboxed, the parent's sandbox flags are combined with
247 // those in |frame_policy|.
248 // Attempting to change the container policy on the main frame will have no
249 // effect.
250 void SetPendingFramePolicy(blink::FramePolicy frame_policy);
251
252 // Returns the currently active frame policy for this frame, including the
253 // sandbox flags which were present at the time the document was loaded, and
Charlie Hu5130d25e2021-03-05 21:53:39254 // the permissions policy container policy, which is set by the iframe's
danakjc492bf82020-09-09 20:02:44255 // allowfullscreen, allowpaymentrequest, and allow attributes, along with the
256 // origin of the iframe's src attribute (which may be different from the URL
257 // of the document currently loaded into the frame). This does not include
258 // policy changes that have been made by updating the containing iframe
259 // element attributes since the frame was last navigated; use
260 // pending_frame_policy() for those.
261 const blink::FramePolicy& effective_frame_policy() const {
Harkiran Bolaria4eacb3a2021-12-13 20:03:47262 return render_manager_.current_replication_state().frame_policy;
danakjc492bf82020-09-09 20:02:44263 }
264
danakjc492bf82020-09-09 20:02:44265 const blink::mojom::FrameOwnerProperties& frame_owner_properties() {
266 return frame_owner_properties_;
267 }
268
269 void set_frame_owner_properties(
270 const blink::mojom::FrameOwnerProperties& frame_owner_properties) {
271 frame_owner_properties_ = frame_owner_properties;
272 }
273
Yuzu Saijo03dbf9b2022-07-22 04:29:45274 // Reflects the attributes of the corresponding iframe html element, such
Arthur Sonzogni64457592022-11-22 11:08:59275 // as 'credentialless', 'id', 'name' and 'src'. These values should not be
Yuzu Saijo03dbf9b2022-07-22 04:29:45276 // exposed to cross-origin renderers.
277 const network::mojom::ContentSecurityPolicy* csp_attribute() const {
278 return attributes_->parsed_csp_attribute.get();
danakjc492bf82020-09-09 20:02:44279 }
Yao Xiao9c54b3e2023-03-14 04:25:04280 // Tracks iframe's 'browsingtopics' attribute, indicating whether the
281 // navigation requests on this frame should calculate and send the
282 // `Sec-Browsing-Topics` header.
283 bool browsing_topics() const { return attributes_->browsing_topics; }
Yuzu Saijodc870f92023-01-20 03:39:11284 const absl::optional<std::string> html_id() const { return attributes_->id; }
Yuzu Saijo03dbf9b2022-07-22 04:29:45285 // This tracks iframe's 'name' attribute instead of window.name, which is
286 // tracked in FrameReplicationState. See the comment for frame_name() for
287 // more details.
Yuzu Saijodc870f92023-01-20 03:39:11288 const absl::optional<std::string> html_name() const {
289 return attributes_->name;
290 }
291 const absl::optional<std::string> html_src() const {
292 return attributes_->src;
293 }
danakjc492bf82020-09-09 20:02:44294
Yuzu Saijo03dbf9b2022-07-22 04:29:45295 void SetAttributes(blink::mojom::IframeAttributesPtr attributes);
Antonio Sartori5abc8de2021-07-13 08:42:47296
danakjc492bf82020-09-09 20:02:44297 bool HasSameOrigin(const FrameTreeNode& node) const {
Harkiran Bolaria4eacb3a2021-12-13 20:03:47298 return render_manager_.current_replication_state().origin.IsSameOriginWith(
299 node.current_replication_state().origin);
danakjc492bf82020-09-09 20:02:44300 }
301
Gyuyoung Kimc16e52e92021-03-19 02:45:37302 const blink::mojom::FrameReplicationState& current_replication_state() const {
Harkiran Bolaria4eacb3a2021-12-13 20:03:47303 return render_manager_.current_replication_state();
danakjc492bf82020-09-09 20:02:44304 }
305
306 RenderFrameHostImpl* current_frame_host() const {
307 return render_manager_.current_frame_host();
308 }
309
danakjc492bf82020-09-09 20:02:44310 // Returns true if this node is in a loading state.
311 bool IsLoading() const;
Nate Chapin470dbc62023-04-25 16:34:38312 LoadingState GetLoadingState() const;
danakjc492bf82020-09-09 20:02:44313
Alex Moshchuk9b0fd822020-10-26 23:08:15314 // Returns true if this node has a cross-document navigation in progress.
315 bool HasPendingCrossDocumentNavigation() const;
316
danakjc492bf82020-09-09 20:02:44317 NavigationRequest* navigation_request() { return navigation_request_.get(); }
318
319 // Transfers the ownership of the NavigationRequest to |render_frame_host|.
320 // From ReadyToCommit to DidCommit, the NavigationRequest is owned by the
321 // RenderFrameHost that is committing the navigation.
322 void TransferNavigationRequestOwnership(
323 RenderFrameHostImpl* render_frame_host);
324
325 // Takes ownership of |navigation_request| and makes it the current
326 // NavigationRequest of this frame. This corresponds to the start of a new
327 // navigation. If there was an ongoing navigation request before calling this
328 // function, it is canceled. |navigation_request| should not be null.
Charlie Reis09952ee2022-12-08 16:35:07329 void TakeNavigationRequest(
danakjc492bf82020-09-09 20:02:44330 std::unique_ptr<NavigationRequest> navigation_request);
331
Rakina Zata Amnif8f2bb62022-11-23 05:54:32332 // Resets the navigation request owned by `this` (which shouldn't have reached
333 // the "pending commit" stage yet) and any state created by it, including the
Rakina Zata Amni33175cb92022-11-24 02:46:03334 // speculative RenderFrameHost (if there are no other navigations associated
335 // with it). Note that this does not affect navigations that have reached the
336 // "pending commit" stage, which are owned by their corresponding
337 // RenderFrameHosts instead.
Daniel Cheng390e2a72022-09-28 06:07:53338 void ResetNavigationRequest(NavigationDiscardReason reason);
339
Rakina Zata Amnif8f2bb62022-11-23 05:54:32340 // Similar to `ResetNavigationRequest()`, but keeps the state created by the
Daniel Cheng390e2a72022-09-28 06:07:53341 // NavigationRequest (e.g. speculative RenderFrameHost, loading state).
342 void ResetNavigationRequestButKeepState();
danakjc492bf82020-09-09 20:02:44343
danakjc492bf82020-09-09 20:02:44344 // The load progress for a RenderFrameHost in this node was updated to
345 // |load_progress|. This will notify the FrameTree which will in turn notify
346 // the WebContents.
347 void DidChangeLoadProgress(double load_progress);
348
349 // Called when the user directed the page to stop loading. Stops all loads
350 // happening in the FrameTreeNode. This method should be used with
351 // FrameTree::ForEach to stop all loads in the entire FrameTree.
352 bool StopLoading();
353
354 // Returns the time this frame was last focused.
355 base::TimeTicks last_focus_time() const { return last_focus_time_; }
356
357 // Called when this node becomes focused. Updates the node's last focused
358 // time and notifies observers.
359 void DidFocus();
360
361 // Called when the user closed the modal dialogue for BeforeUnload and
362 // cancelled the navigation. This should stop any load happening in the
363 // FrameTreeNode.
364 void BeforeUnloadCanceled();
365
danakjc492bf82020-09-09 20:02:44366 // Returns the sandbox flags currently in effect for this frame. This includes
367 // flags inherited from parent frames, the currently active flags from the
368 // <iframe> element hosting this frame, as well as any flags set from a
369 // Content-Security-Policy HTTP header. This does not include flags that have
370 // have been updated in an <iframe> element but have not taken effect yet; use
371 // pending_frame_policy() for those. To see the flags which will take effect
372 // on navigation (which does not include the CSP-set flags), use
373 // effective_frame_policy().
374 network::mojom::WebSandboxFlags active_sandbox_flags() const {
Harkiran Bolaria4eacb3a2021-12-13 20:03:47375 return render_manager_.current_replication_state().active_sandbox_flags;
danakjc492bf82020-09-09 20:02:44376 }
377
danakjc492bf82020-09-09 20:02:44378 // Returns whether the frame received a user gesture on a previous navigation
379 // on the same eTLD+1.
380 bool has_received_user_gesture_before_nav() const {
Harkiran Bolaria4eacb3a2021-12-13 20:03:47381 return render_manager_.current_replication_state()
382 .has_received_user_gesture_before_nav;
danakjc492bf82020-09-09 20:02:44383 }
384
385 // When a tab is discarded, WebContents sets was_discarded on its
386 // root FrameTreeNode.
387 // In addition, when a child frame is created, this bit is passed on from
388 // parent to child.
389 // When a navigation request is created, was_discarded is passed on to the
390 // request and reset to false in FrameTreeNode.
391 void set_was_discarded() { was_discarded_ = true; }
392 bool was_discarded() const { return was_discarded_; }
393
Miyoung Shin8a66ec022022-11-28 23:50:09394 // Deprecated. Use directly HasStickyUserActivation in RFHI.
danakjc492bf82020-09-09 20:02:44395 // Returns the sticky bit of the User Activation v2 state of the
396 // |FrameTreeNode|.
397 bool HasStickyUserActivation() const {
Miyoung Shin8a66ec022022-11-28 23:50:09398 return current_frame_host()->HasStickyUserActivation();
danakjc492bf82020-09-09 20:02:44399 }
400
Miyoung Shin8a66ec022022-11-28 23:50:09401 // Deprecated. Use directly HasStickyUserActivation in RFHI.
danakjc492bf82020-09-09 20:02:44402 // Returns the transient bit of the User Activation v2 state of the
403 // |FrameTreeNode|.
404 bool HasTransientUserActivation() {
Miyoung Shin8a66ec022022-11-28 23:50:09405 return current_frame_host()->HasTransientUserActivation();
danakjc492bf82020-09-09 20:02:44406 }
407
408 // Remove history entries for all frames created by script in this frame's
409 // subtree. If a frame created by a script is removed, then its history entry
410 // will never be reused - this saves memory.
411 void PruneChildFrameNavigationEntries(NavigationEntryImpl* entry);
412
Abhijeet Kandalkarb43affa72022-09-27 16:48:01413 using FencedFrameStatus = RenderFrameHostImpl::FencedFrameStatus;
Abhijeet Kandalkar3f29bc42022-09-23 12:39:58414 FencedFrameStatus fenced_frame_status() const { return fenced_frame_status_; }
415
Kevin McNee43fe8292021-10-04 22:59:41416 blink::FrameOwnerElementType frame_owner_element_type() const {
Daniel Cheng9bd90f92021-04-23 20:49:45417 return frame_owner_element_type_;
danakjc492bf82020-09-09 20:02:44418 }
danakjc492bf82020-09-09 20:02:44419
Daniel Cheng6ac128172021-05-25 18:49:01420 blink::mojom::TreeScopeType tree_scope_type() const {
421 return tree_scope_type_;
422 }
423
arthursonzogni034bb9c2020-10-01 08:29:56424 // The initial popup URL for new window opened using:
425 // `window.open(initial_popup_url)`.
426 // An empty GURL otherwise.
427 //
428 // [WARNING] There is no guarantee the FrameTreeNode will ever host a
429 // document served from this URL. The FrameTreeNode always starts hosting the
430 // initial empty document and attempts a navigation toward this URL. However
431 // the navigation might be delayed, redirected and even cancelled.
432 void SetInitialPopupURL(const GURL& initial_popup_url);
433 const GURL& initial_popup_url() const { return initial_popup_url_; }
434
435 // The origin of the document that used window.open() to create this frame.
436 // Otherwise, an opaque Origin with a nonce different from all previously
437 // existing Origins.
438 void SetPopupCreatorOrigin(const url::Origin& popup_creator_origin);
439 const url::Origin& popup_creator_origin() const {
440 return popup_creator_origin_;
441 }
442
Harkiran Bolaria59290d62021-03-17 01:53:01443 // Sets the associated FrameTree for this node. The node can change FrameTrees
Domenic Denicola7767a9c2023-07-13 15:36:39444 // as part of prerendering, which allows a page loaded in the prerendered
445 // FrameTree to be used for a navigation in the primary frame tree.
Harkiran Bolaria59290d62021-03-17 01:53:01446 void SetFrameTree(FrameTree& frame_tree);
447
Alexander Timin074cd182022-03-23 18:11:22448 using TraceProto = perfetto::protos::pbzero::FrameTreeNodeInfo;
Alexander Timinf785f342021-03-18 00:00:56449 // Write a representation of this object into a trace.
Alexander Timin074cd182022-03-23 18:11:22450 void WriteIntoTrace(perfetto::TracedProto<TraceProto> proto) const;
Alexander Timinf785f342021-03-18 00:00:56451
Carlos Caballero76711352021-03-24 17:38:21452 // Returns true the node is navigating, i.e. it has an associated
453 // NavigationRequest.
454 bool HasNavigation();
455
shivanigithubf3ddff52021-07-03 22:06:30456 // Fenced frames (meta-bug crbug.com/1111084):
shivanigithub4cd016a2021-09-20 21:10:30457 // Note that these two functions cannot be invoked from a FrameTree's or
458 // its root node's constructor since they require the frame tree and the
459 // root node to be completely constructed.
460 //
shivanigithubf3ddff52021-07-03 22:06:30461 // Returns false if fenced frames are disabled. Returns true if the feature is
462 // enabled and if |this| is a fenced frame. Returns false for
463 // iframes embedded in a fenced frame. To clarify: for the MPArch
464 // implementation this only returns true if |this| is the actual
465 // root node of the inner FrameTree and not the proxy FrameTreeNode in the
466 // outer FrameTree.
Dominic Farolino4bc10ee2021-08-31 00:37:36467 bool IsFencedFrameRoot() const;
shivanigithubf3ddff52021-07-03 22:06:30468
469 // Returns false if fenced frames are disabled. Returns true if the
470 // feature is enabled and if |this| or any of its ancestor nodes is a
471 // fenced frame.
472 bool IsInFencedFrameTree() const;
473
shivanigithub4cd016a2021-09-20 21:10:30474 // Returns a valid nonce if `IsInFencedFrameTree()` returns true for `this`.
Garrett Tanzer34cb92fe2022-09-28 17:50:54475 // Returns nullopt otherwise.
476 //
477 // Nonce used in the net::IsolationInfo and blink::StorageKey for a fenced
478 // frame and any iframes nested within it. Not set if this frame is not in a
479 // fenced frame's FrameTree. Note that this could be a field in FrameTree for
480 // the MPArch version but for the shadow DOM version we need to keep it here
481 // since the fenced frame root is not a main frame for the latter. The value
482 // of the nonce will be the same for all of the the iframes inside a fenced
483 // frame tree. If there is a nested fenced frame it will have a different
484 // nonce than its parent fenced frame. The nonce will stay the same across
485 // navigations initiated from the fenced frame tree because it is always used
486 // in conjunction with other fields of the keys and would be good to access
487 // the same storage across same-origin navigations. If the navigation is
488 // same-origin/site then the same network stack partition/storage will be
489 // reused and if it's cross-origin/site then other parts of the key will
490 // change and so, even with the same nonce, another partition will be used.
491 // But if the navigation is initiated from the embedder, the nonce will be
492 // reinitialized irrespective of same or cross origin such that there is no
493 // privacy leak via storage shared between two embedder initiated navigations.
494 // Note that this reinitialization is implemented for all embedder-initiated
495 // navigations in MPArch, but only urn:uuid navigations in ShadowDOM.
496 absl::optional<base::UnguessableToken> GetFencedFrameNonce();
shivanigithub4cd016a2021-09-20 21:10:30497
Garrett Tanzer34cb92fe2022-09-28 17:50:54498 // If applicable, initialize the default fenced frame properties. Right now,
499 // this means setting a new fenced frame nonce. See comment on
shivanigithub4cd016a2021-09-20 21:10:30500 // fenced_frame_nonce() for when it is set to a non-null value. Invoked
501 // by FrameTree::Init() or FrameTree::AddFrame().
Garrett Tanzer34cb92fe2022-09-28 17:50:54502 void SetFencedFramePropertiesIfNeeded();
shivanigithub4cd016a2021-09-20 21:10:30503
Garrett Tanzer291a2d52023-03-20 22:41:57504 // Set the current FencedFrameProperties to have "opaque ads mode".
505 // This should only be used during tests, when the proper embedder-initiated
506 // fenced frame root urn/config navigation flow isn't available.
507 // TODO(crbug.com/1347953): Refactor and expand use of test utils so there is
508 // a consistent way to do this properly everywhere. Consider removing
509 // arbitrary restrictions in "default mode" so that using opaque ads mode is
510 // less necessary.
511 void SetFencedFramePropertiesOpaqueAdsModeForTesting() {
512 if (fenced_frame_properties_.has_value()) {
513 fenced_frame_properties_->mode_ =
514 blink::FencedFrame::DeprecatedFencedFrameMode::kOpaqueAds;
515 }
516 }
517
518 // Returns the mode attribute from the `FencedFrameProperties` if this frame
519 // is in a fenced frame tree, otherwise returns `kDefault`.
520 blink::FencedFrame::DeprecatedFencedFrameMode GetDeprecatedFencedFrameMode();
Nan Lin171fe9a2022-02-17 16:42:16521
Dave Tapuskac8de3b02021-12-03 21:51:01522 // Helper for GetParentOrOuterDocument/GetParentOrOuterDocumentOrEmbedder.
523 // Do not use directly.
Kevin McNee86e64ee2023-02-17 16:35:50524 // `escape_guest_view` determines whether to iterate out of guest views and is
525 // the behaviour distinction between GetParentOrOuterDocument and
526 // GetParentOrOuterDocumentOrEmbedder. See the comment on
527 // GetParentOrOuterDocumentOrEmbedder for details.
528 // `include_prospective` includes embedders which own our frame tree, but have
529 // not yet attached it to the outer frame tree.
Arthur Hemerya06697f2023-03-14 09:20:57530 RenderFrameHostImpl* GetParentOrOuterDocumentHelper(
531 bool escape_guest_view,
532 bool include_prospective) const;
Dave Tapuskac8de3b02021-12-03 21:51:01533
Harkiran Bolariab4437fd2021-08-11 17:51:22534 // Sets the unique_name and name fields on replication_state_. To be used in
535 // prerender activation to make sure the FrameTreeNode replication state is
536 // correct after the RenderFrameHost is moved between FrameTreeNodes. The
537 // renderers should already have the correct value, so unlike
538 // FrameTreeNode::SetFrameName, we do not notify them here.
Harkiran Bolaria4eacb3a2021-12-13 20:03:47539 // TODO(https://crbug.com/1237091): Remove this once the BrowsingContextState
540 // is implemented to utilize the new path.
Harkiran Bolariab4437fd2021-08-11 17:51:22541 void set_frame_name_for_activation(const std::string& unique_name,
542 const std::string& name) {
Harkiran Bolaria0b3bdef02022-03-10 13:04:40543 current_frame_host()->browsing_context_state()->set_frame_name(unique_name,
544 name);
Harkiran Bolariab4437fd2021-08-11 17:51:22545 }
546
Nan Linaaf84f72021-12-02 22:31:56547 // Returns true if error page isolation is enabled.
548 bool IsErrorPageIsolationEnabled() const;
549
W. James MacLean81b8d01f2022-01-25 20:50:59550 // Functions to store and retrieve a frame's srcdoc value on this
551 // FrameTreeNode.
552 void SetSrcdocValue(const std::string& srcdoc_value);
553 const std::string& srcdoc_value() const { return srcdoc_value_; }
554
Garrett Tanzerc69f4642022-08-15 22:15:14555 void set_fenced_frame_properties(
Garrett Tanzer29de7112022-12-06 21:26:32556 const absl::optional<FencedFrameProperties>& fenced_frame_properties) {
Garrett Tanzer2975eeac2022-08-22 16:34:01557 // TODO(crbug.com/1262022): Reenable this DCHECK once ShadowDOM and
558 // loading urns in iframes (for FLEDGE OT) are gone.
559 // DCHECK_EQ(fenced_frame_status_,
560 // RenderFrameHostImpl::FencedFrameStatus::kFencedFrameRoot);
Garrett Tanzerc69f4642022-08-15 22:15:14561 fenced_frame_properties_ = fenced_frame_properties;
562 }
563
Xiaochen Zhou90858e82023-05-31 15:47:37564 // By default, this function checks the fenced frame root's properties if one
565 // exists, and then otherwise traverses the frame tree to find urn iframe
566 // roots. This doesn't work correctly for urn iframes nested inside of fenced
567 // frames. Enable `force_tree_traversal` to skip the fenced frame root short
568 // circuit and always traverse the tree.
569 // TODO(crbug.com/1355857): This function has the correct semantics when
570 // `force_tree_traversal` is set to true. It is set to false for urn iframes
571 // nested in fenced frames to work correctly in some cases. For example,
572 // storage partitioning. Once those issues are resolved, remove this parameter
573 // entirely.
574 const absl::optional<FencedFrameProperties>& GetFencedFrameProperties(
575 bool force_tree_traversal = false);
Garrett Tanzerc69f4642022-08-15 22:15:14576
Liam Brady6da2cc9e2023-01-30 17:09:43577 // Called from the currently active document via the
578 // `Fence.setReportEventDataForAutomaticBeacons` JS API.
579 void SetFencedFrameAutomaticBeaconReportEventData(
580 const std::string& event_data,
Nan Lindbce6e32023-05-10 22:42:55581 const std::vector<blink::FencedFrame::ReportingDestination>& destinations,
582 network::AttributionReportingRuntimeFeatures
Liam Bradybe6621d12023-07-20 19:43:40583 attribution_reporting_runtime_features,
584 bool once) override;
585
586 // Helper function to clear out automatic beacon data after one automatic
587 // beacon if `once` was set to true when calling
588 // `setReportEventDataForAutomaticBeacons()`.
589 void MaybeResetFencedFrameAutomaticBeaconReportEventData();
Liam Brady6da2cc9e2023-01-30 17:09:43590
Yao Xiaof9ae90a2023-03-01 20:52:44591 // Returns the number of fenced frame boundaries above this frame. The
Yao Xiaoa2337ad2022-10-12 20:59:29592 // outermost main frame's frame tree has fenced frame depth 0, a topmost
593 // fenced frame tree embedded in the outermost main frame has fenced frame
594 // depth 1, etc.
Yao Xiaof9ae90a2023-03-01 20:52:44595 //
596 // Also, sets `shared_storage_fenced_frame_root_count` to the
597 // number of fenced frame boundaries (roots) above this frame that originate
598 // from shared storage. This is used to check whether a fenced frame
599 // originates from shared storage only (i.e. not from FLEDGE).
600 // TODO(crbug.com/1347953): Remove this check once we put permissions inside
601 // FencedFrameConfig.
602 size_t GetFencedFrameDepth(size_t& shared_storage_fenced_frame_root_count);
Yao Xiaoa2337ad2022-10-12 20:59:29603
604 // Traverse up from this node. Return all valid
605 // `node->fenced_frame_properties_->shared_storage_budget_metadata` (i.e. this
606 // node is subjected to the shared storage budgeting associated with those
607 // metadata). Every node that originates from sharedStorage.selectURL() will
608 // have an associated metadata. This indicates that the metadata can only
609 // possibly be associated with a fenced frame root, unless when
610 // `kAllowURNsInIframes` is enabled in which case they could be be associated
611 // with any node.
Garrett Tanzer29de7112022-12-06 21:26:32612 std::vector<const SharedStorageBudgetMetadata*>
Yao Xiao1ac702d2022-06-08 17:20:49613 FindSharedStorageBudgetMetadata();
614
Camillia Smith Barnes7218518c2023-03-06 19:02:17615 // Returns any shared storage context string that was written to a
616 // `blink::FencedFrameConfig` before navigation via
617 // `setSharedStorageContext()`, as long as the request is for a same-origin
618 // frame within the config's fenced frame tree (or a same-origin descendant of
619 // a URN iframe).
620 absl::optional<std::u16string> GetEmbedderSharedStorageContextIfAllowed();
621
Harkiran Bolariaebbe7702022-02-22 19:19:03622 // Accessor to BrowsingContextState for subframes only. Only main frame
623 // navigations can change BrowsingInstances and BrowsingContextStates,
624 // therefore for subframes associated BrowsingContextState never changes. This
625 // helper method makes this more explicit and guards against calling this on
626 // main frames (there an appropriate BrowsingContextState should be obtained
627 // from RenderFrameHost or from RenderFrameProxyHost as e.g. during
628 // cross-BrowsingInstance navigations multiple BrowsingContextStates exist in
629 // the same frame).
630 const scoped_refptr<BrowsingContextState>&
631 GetBrowsingContextStateForSubframe() const;
632
Arthur Hemerye4659282022-03-28 08:36:15633 // Clears the opener property of popups referencing this FrameTreeNode as
634 // their opener.
635 void ClearOpenerReferences();
636
Liam Brady95d36d12023-03-13 21:13:06637 // Calculates whether one of the ancestor frames or this frame has a CSPEE in
638 // place. This is eventually sent over to LocalFrame in the renderer where it
639 // will be used by NavigatorAuction::canLoadAdAuctionFencedFrame for
640 // information it can't get on its own.
Liam Bradyd2a41e152022-07-19 13:58:48641 bool AncestorOrSelfHasCSPEE() const;
642
Arthur Sonzogni8e8eb1f2023-01-10 14:51:01643 // Reset every navigation in this frame, and its descendants. This is called
644 // after the <iframe> element has been removed, or after the document owning
645 // this frame has been navigated away.
646 //
647 // This takes into account:
648 // - Non-pending commit NavigationRequest owned by the FrameTreeNode
649 // - Pending commit NavigationRequest owned by the current RenderFrameHost
650 // - Speculative RenderFrameHost and its pending commit NavigationRequests.
651 void ResetAllNavigationsForFrameDetach();
652
Miyoung Shin7cf88b42022-11-07 13:22:30653 // RenderFrameHostOwner implementation:
Nate Chapin470dbc62023-04-25 16:34:38654 void DidStartLoading(LoadingState previous_frame_tree_loading_state) override;
Julie Jeongeun Kim07c077bd2022-12-05 08:40:31655 void DidStopLoading() override;
Miyoung Shin7cf88b42022-11-07 13:22:30656 void RestartNavigationAsCrossDocument(
657 std::unique_ptr<NavigationRequest> navigation_request) override;
Miyoung Shin1504eb712022-12-07 10:32:18658 bool Reload() override;
Julie Jeongeun Kimc1b07c32022-11-11 10:26:32659 Navigator& GetCurrentNavigator() override;
Miyoung Shine16cd2262022-11-30 05:52:16660 RenderFrameHostManager& GetRenderFrameHostManager() override;
Miyoung Shin64fd1bea2023-01-04 04:22:08661 FrameTreeNode* GetOpener() const override;
Julie Jeongeun Kim2132b37f82022-11-23 08:30:46662 void SetFocusedFrame(SiteInstanceGroup* source) override;
Julie Jeongeun Kim0e242242022-11-30 10:45:09663 void DidChangeReferrerPolicy(
664 network::mojom::ReferrerPolicy referrer_policy) override;
Miyoung Shin7cf88b42022-11-07 13:22:30665
Miyoung Shin8a66ec022022-11-28 23:50:09666 // Updates the user activation state in the browser frame tree and in the
667 // frame trees in all renderer processes except the renderer for this node
668 // (which initiated the update). Returns |false| if the update tries to
669 // consume an already consumed/expired transient state, |true| otherwise. See
670 // the comment on `user_activation_state_` in RenderFrameHostImpl.
671 //
672 // The |notification_type| parameter is used for histograms, only for the case
673 // |update_state == kNotifyActivation|.
674 bool UpdateUserActivationState(
675 blink::mojom::UserActivationUpdateType update_type,
676 blink::mojom::UserActivationNotificationType notification_type) override;
677
Nate Chapin47276a62023-02-16 16:53:44678 void DidConsumeHistoryUserActivation() override;
679
Miyoung Shinff13ed22022-11-30 09:21:47680 std::unique_ptr<NavigationRequest>
681 CreateNavigationRequestForSynchronousRendererCommit(
682 RenderFrameHostImpl* render_frame_host,
683 bool is_same_document,
684 const GURL& url,
685 const url::Origin& origin,
W. James MacLean23e90a12022-12-21 04:38:21686 const absl::optional<GURL>& initiator_base_url,
Miyoung Shinff13ed22022-11-30 09:21:47687 const net::IsolationInfo& isolation_info_for_subresources,
688 blink::mojom::ReferrerPtr referrer,
689 const ui::PageTransition& transition,
690 bool should_replace_current_entry,
691 const std::string& method,
692 bool has_transient_activation,
693 bool is_overriding_user_agent,
694 const std::vector<GURL>& redirects,
695 const GURL& original_url,
696 std::unique_ptr<CrossOriginEmbedderPolicyReporter> coep_reporter,
Miyoung Shinff13ed22022-11-30 09:21:47697 int http_response_code) override;
Miyoung Shinb5561802022-12-01 08:21:35698 void CancelNavigation() override;
Miyoung Shinc9ff4812023-01-05 08:58:05699 bool Credentialless() const override;
Miyoung Shinaf9a34362023-01-31 02:46:51700#if !BUILDFLAG(IS_ANDROID)
701 void GetVirtualAuthenticatorManager(
702 mojo::PendingReceiver<blink::test::mojom::VirtualAuthenticatorManager>
703 receiver) override;
704#endif
Miyoung Shinff13ed22022-11-30 09:21:47705
Mingyu Lei7956b8b2023-07-24 08:24:08706 // Restart the navigation restoring the page from the back-forward cache
707 // as a regular non-BFCached history navigation.
708 //
709 // The restart itself is asynchronous as it's dangerous to restart navigation
710 // with arbitrary state on the stack (another navigation might be starting),
711 // so this function only posts the actual task to do all the work (See
712 // `RestartBackForwardCachedNavigationImpl()`).
713 void RestartBackForwardCachedNavigationAsync(int nav_entry_id);
714
715 // Cancel the asynchronous task that would restart the BFCache navigation.
716 // This should be called whenever a FrameTreeNode's NavigationRequest would
717 // normally get cancelled, including when another NavigationRequest starts.
718 // This preserves the previous behavior where a restarting BFCache
719 // NavigationRequest is kept around until the task to create the new
720 // navigation is run, or until that NavigationRequest gets deleted (which
721 // cancels the task).
722 void CancelRestartingBackForwardCacheNavigation();
723
danakjc492bf82020-09-09 20:02:44724 private:
Yuzu Saijo03dbf9b2022-07-22 04:29:45725 friend class CSPEmbeddedEnforcementUnitTest;
Charlie Hubb5943d2021-03-09 19:46:12726 FRIEND_TEST_ALL_PREFIXES(SitePerProcessPermissionsPolicyBrowserTest,
danakjc492bf82020-09-09 20:02:44727 ContainerPolicyDynamic);
Charlie Hubb5943d2021-03-09 19:46:12728 FRIEND_TEST_ALL_PREFIXES(SitePerProcessPermissionsPolicyBrowserTest,
danakjc492bf82020-09-09 20:02:44729 ContainerPolicySandboxDynamic);
Yuzu Saijo03dbf9b2022-07-22 04:29:45730 FRIEND_TEST_ALL_PREFIXES(NavigationRequestTest, StorageKeyToCommit);
Arthur Sonzogni64457592022-11-22 11:08:59731 FRIEND_TEST_ALL_PREFIXES(
732 NavigationRequestTest,
733 NavigationToCredentiallessDocumentNetworkIsolationInfo);
Yuzu Saijo03dbf9b2022-07-22 04:29:45734 FRIEND_TEST_ALL_PREFIXES(RenderFrameHostImplTest,
Arthur Sonzogni64457592022-11-22 11:08:59735 ChildOfCredentiallessIsCredentialless);
Yifan Luo86a79f42022-08-16 18:38:27736 FRIEND_TEST_ALL_PREFIXES(ContentPasswordManagerDriverTest,
Arthur Sonzogni64457592022-11-22 11:08:59737 PasswordAutofillDisabledOnCredentiallessIframe);
danakjc492bf82020-09-09 20:02:44738
Dominic Farolino8a2187b2021-12-24 20:44:21739 // Called by the destructor. When `this` is an outer dummy FrameTreeNode
740 // representing an inner FrameTree, this method destroys said inner FrameTree.
741 void DestroyInnerFrameTreeIfExists();
742
danakjc492bf82020-09-09 20:02:44743 class OpenerDestroyedObserver;
744
danakjc492bf82020-09-09 20:02:44745 // The |notification_type| parameter is used for histograms only.
746 bool NotifyUserActivation(
747 blink::mojom::UserActivationNotificationType notification_type);
748
749 bool ConsumeTransientUserActivation();
750
751 bool ClearUserActivation();
752
753 // Verify that the renderer process is allowed to set user activation on this
754 // frame by checking whether this frame's RenderWidgetHost had previously seen
755 // an input event that might lead to user activation. If user activation
756 // should be allowed, this returns true and also clears corresponding pending
757 // user activation state in the widget. Otherwise, this returns false.
758 bool VerifyUserActivation();
759
Xiaochen Zhou90858e82023-05-31 15:47:37760 // See comments for `GetFencedFrameProperties()`.
761 absl::optional<FencedFrameProperties>& GetFencedFramePropertiesForEditing(
762 bool force_tree_traversal = false);
Liam Brady6da2cc9e2023-01-30 17:09:43763
Mingyu Lei7956b8b2023-07-24 08:24:08764 // See `RestartBackForwardCachedNavigationAsync()`.
765 void RestartBackForwardCachedNavigationImpl(int nav_entry_id);
766
danakjc492bf82020-09-09 20:02:44767 // The next available browser-global FrameTreeNode ID.
768 static int next_frame_tree_node_id_;
769
Arthur Sonzognif6785ec2022-12-05 10:11:50770 // The FrameTree owning |this|. It can change with Prerender2 during
771 // activation.
772 raw_ref<FrameTree> frame_tree_;
danakjc492bf82020-09-09 20:02:44773
danakjc492bf82020-09-09 20:02:44774 // A browser-global identifier for the frame in the page, which stays stable
775 // even if the frame does a cross-process navigation.
776 const int frame_tree_node_id_;
777
778 // The RenderFrameHost owning this FrameTreeNode, which cannot change for the
779 // life of this FrameTreeNode. |nullptr| if this node is the root.
Keishi Hattori0e45c022021-11-27 09:25:52780 const raw_ptr<RenderFrameHostImpl> parent_;
danakjc492bf82020-09-09 20:02:44781
danakjc492bf82020-09-09 20:02:44782 // The frame that opened this frame, if any. Will be set to null if the
783 // opener is closed, or if this frame disowns its opener by setting its
784 // window.opener to null.
Keishi Hattori0e45c022021-11-27 09:25:52785 raw_ptr<FrameTreeNode> opener_ = nullptr;
danakjc492bf82020-09-09 20:02:44786
787 // An observer that clears this node's |opener_| if the opener is destroyed.
788 // This observer is added to the |opener_|'s observer list when the |opener_|
789 // is set to a non-null node, and it is removed from that list when |opener_|
790 // changes or when this node is destroyed. It is also cleared if |opener_|
791 // is disowned.
792 std::unique_ptr<OpenerDestroyedObserver> opener_observer_;
793
Rakina Zata Amni3a48ae42022-05-05 03:39:56794 // Unlike `opener_`, the "original opener chain" doesn't reflect
795 // window.opener, which can be suppressed or updated. The "original opener"
796 // is the main frame of the actual opener of this frame. This traces the all
797 // the way back, so if the original opener was closed (deleted or severed due
798 // to COOP), but _it_ had an original opener, this will return the original
799 // opener's original opener, etc. So this value will always be set as long as
800 // there is at least one live frame in the chain whose connection is not
801 // severed due to COOP.
802 raw_ptr<FrameTreeNode> first_live_main_frame_in_original_opener_chain_ =
803 nullptr;
danakjc492bf82020-09-09 20:02:44804
Wolfgang Beyerd8809db2020-09-30 15:29:39805 // The devtools frame token of the frame which opened this frame. This is
806 // not cleared even if the opener is destroyed or disowns the frame.
Anton Bikineevf62d1bf2021-05-15 17:56:07807 absl::optional<base::UnguessableToken> opener_devtools_frame_token_;
Wolfgang Beyerd8809db2020-09-30 15:29:39808
Rakina Zata Amni3a48ae42022-05-05 03:39:56809 // An observer that updates this node's
810 // |first_live_main_frame_in_original_opener_chain_| to the next original
811 // opener in the chain if the original opener is destroyed.
danakjc492bf82020-09-09 20:02:44812 std::unique_ptr<OpenerDestroyedObserver> original_opener_observer_;
813
arthursonzogni034bb9c2020-10-01 08:29:56814 // When created by an opener, the URL specified in window.open(url)
815 // Please refer to {Get,Set}InitialPopupURL() documentation.
816 GURL initial_popup_url_;
817
818 // When created using window.open, the origin of the creator.
819 // Please refer to {Get,Set}PopupCreatorOrigin() documentation.
820 url::Origin popup_creator_origin_;
821
W. James MacLean81b8d01f2022-01-25 20:50:59822 // If the url from the the last BeginNavigation is about:srcdoc, this value
823 // stores the srcdoc_attribute's value for re-use in history navigations.
824 std::string srcdoc_value_;
825
danakjc492bf82020-09-09 20:02:44826 // Whether the frame's owner element in the parent document is collapsed.
arthursonzogni9816b9192021-03-29 16:09:19827 bool is_collapsed_ = false;
danakjc492bf82020-09-09 20:02:44828
Daniel Cheng6ac128172021-05-25 18:49:01829 // The type of frame owner for this frame. This is only relevant for non-main
830 // frames.
Kevin McNee43fe8292021-10-04 22:59:41831 const blink::FrameOwnerElementType frame_owner_element_type_ =
832 blink::FrameOwnerElementType::kNone;
Daniel Cheng9bd90f92021-04-23 20:49:45833
Daniel Cheng6ac128172021-05-25 18:49:01834 // The tree scope type of frame owner element, i.e. whether the element is in
835 // the document tree (https://dom.spec.whatwg.org/#document-trees) or the
836 // shadow tree (https://dom.spec.whatwg.org/#shadow-trees). This is only
837 // relevant for non-main frames.
838 const blink::mojom::TreeScopeType tree_scope_type_ =
839 blink::mojom::TreeScopeType::kDocument;
840
danakjc492bf82020-09-09 20:02:44841 // Track the pending sandbox flags and container policy for this frame. When a
842 // parent frame dynamically updates 'sandbox', 'allow', 'allowfullscreen',
843 // 'allowpaymentrequest' or 'src' attributes, the updated policy for the frame
Harkiran Bolaria4eacb3a2021-12-13 20:03:47844 // is stored here, and transferred into
845 // render_manager_.current_replication_state().frame_policy when they take
846 // effect on the next frame navigation.
danakjc492bf82020-09-09 20:02:44847 blink::FramePolicy pending_frame_policy_;
848
849 // Whether the frame was created by javascript. This is useful to prune
850 // history entries when the frame is removed (because frames created by
851 // scripts are never recreated with the same unique name - see
852 // https://crbug.com/500260).
arthursonzogni9816b9192021-03-29 16:09:19853 const bool is_created_by_script_;
danakjc492bf82020-09-09 20:02:44854
danakjc492bf82020-09-09 20:02:44855 // Tracks the scrolling and margin properties for this frame. These
856 // properties affect the child renderer but are stored on its parent's
857 // frame element. When this frame's parent dynamically updates these
858 // properties, we update them here too.
859 //
860 // Note that dynamic updates only take effect on the next frame navigation.
861 blink::mojom::FrameOwnerProperties frame_owner_properties_;
862
Yuzu Saijo03dbf9b2022-07-22 04:29:45863 // Contains the tracked HTML attributes of the corresponding iframe element,
864 // such as 'id' and 'src'.
865 blink::mojom::IframeAttributesPtr attributes_;
Antonio Sartori5abc8de2021-07-13 08:42:47866
danakjc492bf82020-09-09 20:02:44867 // Owns an ongoing NavigationRequest until it is ready to commit. It will then
868 // be reset and a RenderFrameHost will be responsible for the navigation.
869 std::unique_ptr<NavigationRequest> navigation_request_;
870
871 // List of objects observing this FrameTreeNode.
872 base::ObserverList<Observer>::Unchecked observers_;
873
874 base::TimeTicks last_focus_time_;
875
arthursonzogni9816b9192021-03-29 16:09:19876 bool was_discarded_ = false;
danakjc492bf82020-09-09 20:02:44877
Abhijeet Kandalkar3f29bc42022-09-23 12:39:58878 const FencedFrameStatus fenced_frame_status_ =
879 FencedFrameStatus::kNotNestedInFencedFrame;
Harkiran Bolaria16f2c48d2022-04-22 12:39:57880
Garrett Tanzerc69f4642022-08-15 22:15:14881 // If this is a fenced frame resulting from a urn:uuid navigation, this
882 // contains all the metadata specifying the resulting context.
Garrett Tanzer34cb92fe2022-09-28 17:50:54883 // TODO(crbug.com/1262022): Move this into the FrameTree once ShadowDOM
884 // and urn iframes are gone.
Garrett Tanzer29de7112022-12-06 21:26:32885 absl::optional<FencedFrameProperties> fenced_frame_properties_;
Garrett Tanzerc69f4642022-08-15 22:15:14886
Mingyu Lei7956b8b2023-07-24 08:24:08887 // The tracker of the task that restarts the BFCache navigation. It might be
888 // used to cancel the task.
889 // See `CancelRestartingBackForwardCacheNavigation()`.
890 base::CancelableTaskTracker restart_back_forward_cached_navigation_tracker_;
891
Lukasz Anforowicz147141962020-12-16 18:03:24892 // Manages creation and swapping of RenderFrameHosts for this frame.
893 //
894 // This field needs to be declared last, because destruction of
895 // RenderFrameHostManager may call arbitrary callbacks (e.g. via
896 // WebContentsObserver::DidFinishNavigation fired after RenderFrameHostManager
897 // destructs a RenderFrameHostImpl and its NavigationRequest). Such callbacks
898 // may try to use FrameTreeNode's fields above - this would be an undefined
899 // behavior if the fields (even trivially-destructible ones) were destructed
900 // before the RenderFrameHostManager's destructor runs. See also
901 // https://crbug.com/1157988.
902 RenderFrameHostManager render_manager_;
Mingyu Lei7956b8b2023-07-24 08:24:08903
904 base::WeakPtrFactory<FrameTreeNode> weak_factory_{this};
danakjc492bf82020-09-09 20:02:44905};
906
907} // namespace content
908
909#endif // CONTENT_BROWSER_RENDERER_HOST_FRAME_TREE_NODE_H_