1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
|
// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_FENCED_FRAME_FENCED_FRAME_H_
#define CONTENT_BROWSER_FENCED_FRAME_FENCED_FRAME_H_
#include <memory>
#include <string>
#include "base/memory/raw_ptr.h"
#include "base/memory/safe_ref.h"
#include "content/browser/renderer_host/frame_tree.h"
#include "content/browser/renderer_host/navigation_controller_delegate.h"
#include "content/common/content_export.h"
#include "content/common/frame.mojom.h"
#include "mojo/public/cpp/bindings/associated_receiver.h"
#include "mojo/public/cpp/bindings/pending_associated_receiver.h"
#include "third_party/blink/public/mojom/fenced_frame/fenced_frame.mojom.h"
class GURL;
namespace content {
class RenderFrameHostImpl;
class RenderFrameProxyHost;
class WebContentsImpl;
// This is the browser-side host object for the <fencedframe> element
// implemented in Blink. It is owned by and stored directly on
// `RenderFrameHostImpl`.
class CONTENT_EXPORT FencedFrame : public blink::mojom::FencedFrameOwnerHost,
public FrameTree::Delegate,
public NavigationControllerDelegate {
public:
FencedFrame(base::SafeRef<RenderFrameHostImpl> owner_render_frame_host,
bool was_discarded);
~FencedFrame() override;
void Bind(mojo::PendingAssociatedReceiver<blink::mojom::FencedFrameOwnerHost>
receiver) {
receiver_.Bind(std::move(receiver));
}
// Called when a fenced frame is created from a synchronous IPC from the
// renderer. This creates a proxy representing the main frame of the inner
// `FrameTree`, for use by the embedding RenderFrameHostImpl.
// `remote_frame_interfaces` must not be null.
RenderFrameProxyHost* InitInnerFrameTreeAndReturnProxyToOuterFrameTree(
blink::mojom::RemoteFrameInterfacesFromRendererPtr
remote_frame_interfaces,
const blink::RemoteFrameToken& frame_token,
const base::UnguessableToken& devtools_frame_token);
// blink::mojom::FencedFrameOwnerHost implementation.
void Navigate(const GURL& url,
base::TimeTicks navigation_start_time,
const std::optional<std::u16string>&
embedder_shared_storage_context) override;
void DidChangeFramePolicy(const blink::FramePolicy& frame_policy) override;
// FrameTree::Delegate.
void LoadingStateChanged(LoadingState new_state) override {}
void DidStartLoading(FrameTreeNode* frame_tree_node) override {}
void DidStopLoading() override {}
bool IsHidden() override;
FrameTreeNodeId GetOuterDelegateFrameTreeNodeId() override;
RenderFrameHostImpl* GetProspectiveOuterDocument() override;
FrameTree* LoadingTree() override;
void SetFocusedFrame(FrameTreeNode* node, SiteInstanceGroup* source) override;
FrameTree* GetOwnedPictureInPictureFrameTree() override;
FrameTree* GetPictureInPictureOpenerFrameTree() override;
bool OnRenderFrameProxyVisibilityChanged(
RenderFrameProxyHost* render_frame_proxy_host,
blink::mojom::FrameVisibility visibility) override;
// Returns the devtools frame token of the fenced frame's inner FrameTree's
// main frame.
const base::UnguessableToken& GetDevToolsFrameToken() const;
RenderFrameHostImpl* GetInnerRoot() { return frame_tree_->GetMainFrame(); }
private:
// NavigationControllerDelegate
void NotifyNavigationStateChangedFromController(
InvalidateTypes changed_flags) override {}
void NotifyBeforeFormRepostWarningShow() override;
void NotifyNavigationEntryCommitted(
const LoadCommittedDetails& load_details) override;
void NotifyNavigationEntryChanged(
const EntryChangedDetails& change_details) override;
void NotifyNavigationListPruned(const PrunedDetails& pruned_details) override;
void NotifyNavigationEntriesDeleted() override;
void ActivateAndShowRepostFormWarningDialog() override;
bool ShouldPreserveAbortedURLs() override;
void UpdateOverridingUserAgent() override;
const raw_ptr<WebContentsImpl> web_contents_;
// This is the RenderFrameHostImpl that owns the <fencedframe> element in the
// renderer, as such this object never outlives the RenderFrameHostImpl (and
// SafeRef will crash safely in the case of a bug). The FencedFrame may be
// detached and destroyed before the `owner_render_frame_host_` if removed
// from the DOM by the renderer. Otherwise, it will be detached and destroyed
// with the current document in the ancestor `owner_render_frame_host_`.
base::SafeRef<RenderFrameHostImpl> owner_render_frame_host_;
// The FrameTreeNode in the outer FrameTree that represents the inner fenced
// frame FrameTree. It is a "dummy" child FrameTreeNode that `this` is
// responsible for adding as a child of `owner_render_frame_host_`; it is
// initially null, and only set in the constructor (indirectly via
// `InitInnerFrameTreeAndReturnProxyToOuterFrameTree()`).
// Furthermore, the lifetime of `this` is directly tied to it (see
// `OnFrameTreeNodeDestroyed()`).
raw_ptr<FrameTreeNode> outer_delegate_frame_tree_node_ = nullptr;
// The FrameTree that we create to host the "inner" fenced frame contents.
std::unique_ptr<FrameTree> frame_tree_;
// Receives messages from the frame owner element in Blink.
mojo::AssociatedReceiver<blink::mojom::FencedFrameOwnerHost> receiver_{this};
};
} // namespace content
#endif // CONTENT_BROWSER_FENCED_FRAME_FENCED_FRAME_H_
|