blob: e7f2e54377778a5168b6494f00e08e8c84972b70 [file] [log] [blame]
[email protected]5a7100d2014-05-19 01:29:041// Copyright 2014 The Chromium Authors. All rights reserved.
2// 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_RENDERER_RENDER_FRAME_PROXY_H_
6#define CONTENT_RENDERER_RENDER_FRAME_PROXY_H_
7
avi1023d012015-12-25 02:39:148#include "base/macros.h"
[email protected]e3244ed2014-06-20 20:04:279#include "base/memory/ref_counted.h"
[email protected]5a7100d2014-05-19 01:29:0410#include "content/common/content_export.h"
11#include "ipc/ipc_listener.h"
12#include "ipc/ipc_sender.h"
alexmos401f0aba2015-12-06 10:07:3913#include "third_party/WebKit/public/platform/WebFocusType.h"
mkwstf672e7ef2016-06-09 20:51:0714#include "third_party/WebKit/public/platform/WebInsecureRequestPolicy.h"
[email protected]5a7100d2014-05-19 01:29:0415#include "third_party/WebKit/public/web/WebRemoteFrame.h"
japhet4dad341e2014-09-09 21:11:1116#include "third_party/WebKit/public/web/WebRemoteFrameClient.h"
mkwst13213f32015-07-27 07:06:2717#include "url/origin.h"
[email protected]5a7100d2014-05-19 01:29:0418
creis5834fe5e2014-10-10 21:50:4919namespace blink {
20class WebInputEvent;
lazyboy0882dfce2015-08-16 05:47:3821struct WebRect;
creis5834fe5e2014-10-10 21:50:4922}
23
kenrbfc7c02c92015-05-29 22:20:5824namespace cc {
fsamuel845b8712016-05-25 17:36:1125class SurfaceId;
kenrbfc7c02c92015-05-29 22:20:5826struct SurfaceSequence;
27}
28
[email protected]5a7100d2014-05-19 01:29:0429namespace content {
30
[email protected]e3244ed2014-06-20 20:04:2731class ChildFrameCompositingHelper;
[email protected]5a7100d2014-05-19 01:29:0432class RenderFrameImpl;
33class RenderViewImpl;
lfgd64bb292016-01-18 23:57:3134class RenderWidget;
lukasza8e1c02e42016-05-17 20:05:1035struct ContentSecurityPolicyHeader;
raymesbba82b32016-07-19 00:41:3836struct FrameOwnerProperties;
alexmosbc7eafa2014-12-06 01:38:0937struct FrameReplicationState;
[email protected]5a7100d2014-05-19 01:29:0438
39// When a page's frames are rendered by multiple processes, each renderer has a
40// full copy of the frame tree. It has full RenderFrames for the frames it is
41// responsible for rendering and placeholder objects for frames rendered by
42// other processes. This class is the renderer-side object for the placeholder.
43// RenderFrameProxy allows us to keep existing window references valid over
44// cross-process navigations and route cross-site asynchronous JavaScript calls,
45// such as postMessage.
46//
47// For now, RenderFrameProxy is created when RenderFrame is swapped out. It
48// acts as a wrapper and is used for sending and receiving IPC messages. It is
49// deleted when the RenderFrame is swapped back in or the node of the frame
50// tree is deleted.
51//
52// Long term, RenderFrameProxy will be created to replace the RenderFrame in the
53// frame tree and the RenderFrame will be deleted after its unload handler has
54// finished executing. It will still be responsible for routing IPC messages
55// which are valid for cross-site interactions between frames.
56// RenderFrameProxy will be deleted when the node in the frame tree is deleted
57// or when navigating the frame causes it to return to this process and a new
58// RenderFrame is created for it.
59class CONTENT_EXPORT RenderFrameProxy
60 : public IPC::Listener,
61 public IPC::Sender,
japhet4dad341e2014-09-09 21:11:1162 NON_EXPORTED_BASE(public blink::WebRemoteFrameClient) {
[email protected]5a7100d2014-05-19 01:29:0463 public:
[email protected]c092f5c2014-07-18 01:34:3364 // This method should be used to create a RenderFrameProxy, which will replace
65 // an existing RenderFrame during its cross-process navigation from the
66 // current process to a different one. |routing_id| will be ID of the newly
67 // created RenderFrameProxy. |frame_to_replace| is the frame that the new
68 // proxy will eventually swap places with.
69 static RenderFrameProxy* CreateProxyToReplaceFrame(
70 RenderFrameImpl* frame_to_replace,
dcheng860817a2015-05-22 03:16:5671 int routing_id,
72 blink::WebTreeScopeType scope);
[email protected]c092f5c2014-07-18 01:34:3373
74 // This method should be used to create a RenderFrameProxy, when there isn't
75 // an existing RenderFrame. It should be called to construct a local
76 // representation of a RenderFrame that has been created in another process --
77 // for example, after a cross-process navigation or after the addition of a
78 // new frame local to some other process. |routing_id| will be the ID of the
alexmosa181efc2015-09-03 00:39:0479 // newly created RenderFrameProxy. |render_view_routing_id| identifies the
nick3b5a21f2016-11-22 23:07:1180 // RenderView to be associated with this frame. |opener|, if supplied, is the
81 // new frame's opener. |parent_routing_id| is the routing ID of the
82 // RenderFrameProxy to which the new frame is parented.
[email protected]c092f5c2014-07-18 01:34:3383 //
84 // |parent_routing_id| always identifies a RenderFrameProxy (never a
85 // RenderFrame) because a new child of a local frame should always start out
86 // as a frame, not a proxy.
alexmosbc7eafa2014-12-06 01:38:0987 static RenderFrameProxy* CreateFrameProxy(
88 int routing_id,
alexmosbc7eafa2014-12-06 01:38:0989 int render_view_routing_id,
nick3b5a21f2016-11-22 23:07:1190 blink::WebFrame* opener,
alexmosa181efc2015-09-03 00:39:0491 int parent_routing_id,
alexmosbc7eafa2014-12-06 01:38:0992 const FrameReplicationState& replicated_state);
[email protected]5a7100d2014-05-19 01:29:0493
94 // Returns the RenderFrameProxy for the given routing ID.
95 static RenderFrameProxy* FromRoutingID(int routing_id);
96
[email protected]c092f5c2014-07-18 01:34:3397 // Returns the RenderFrameProxy given a WebFrame.
98 static RenderFrameProxy* FromWebFrame(blink::WebFrame* web_frame);
99
dcheng6d18e402014-10-21 12:32:52100 ~RenderFrameProxy() override;
[email protected]5a7100d2014-05-19 01:29:04101
102 // IPC::Sender
dcheng6d18e402014-10-21 12:32:52103 bool Send(IPC::Message* msg) override;
[email protected]5a7100d2014-05-19 01:29:04104
[email protected]e3244ed2014-06-20 20:04:27105 // Out-of-process child frames receive a signal from RenderWidgetCompositor
lfge6119aac2016-01-27 02:14:31106 // when a compositor frame will begin.
107 void WillBeginCompositorFrame();
108
109 // Out-of-process child frames receive a signal from RenderWidgetCompositor
[email protected]e3244ed2014-06-20 20:04:27110 // when a compositor frame has committed.
111 void DidCommitCompositorFrame();
112
alexmosbc7eafa2014-12-06 01:38:09113 // Pass replicated information, such as security origin, to this
114 // RenderFrameProxy's WebRemoteFrame.
115 void SetReplicatedState(const FrameReplicationState& state);
116
[email protected]82307f6b2014-08-07 03:30:12117 int routing_id() { return routing_id_; }
118 RenderViewImpl* render_view() { return render_view_; }
119 blink::WebRemoteFrame* web_frame() { return web_frame_; }
[email protected]c092f5c2014-07-18 01:34:33120
lfgd64bb292016-01-18 23:57:31121 // Returns the widget used for the local frame root.
122 RenderWidget* render_widget() { return render_widget_; }
123
japhet4dad341e2014-09-09 21:11:11124 // blink::WebRemoteFrameClient implementation:
avi5c77d212015-09-25 20:08:25125 void frameDetached(DetachType type) override;
dchengb4a1a32e2016-05-17 01:57:00126 void forwardPostMessage(blink::WebLocalFrame* sourceFrame,
127 blink::WebRemoteFrame* targetFrame,
128 blink::WebSecurityOrigin target,
129 blink::WebDOMMessageEvent event) override;
avi5c77d212015-09-25 20:08:25130 void navigate(const blink::WebURLRequest& request,
131 bool should_replace_current_entry) override;
132 void forwardInputEvent(const blink::WebInputEvent* event) override;
133 void frameRectsChanged(const blink::WebRect& frame_rect) override;
ekaramadbabb9bf2016-01-12 15:17:02134 void visibilityChanged(bool visible) override;
japhet74e6d692016-10-27 00:44:30135 void setHasReceivedUserGesture() override;
avi5c77d212015-09-25 20:08:25136 void didChangeOpener(blink::WebFrame* opener) override;
alexmos401f0aba2015-12-06 10:07:39137 void advanceFocus(blink::WebFocusType type,
138 blink::WebLocalFrame* source) override;
alexmos5357efb2015-12-16 21:44:00139 void frameFocused() override;
japhet4dad341e2014-09-09 21:11:11140
nasko3e8c20e2014-12-18 06:54:56141 // IPC handlers
142 void OnDidStartLoading();
143
[email protected]5a7100d2014-05-19 01:29:04144 private:
145 RenderFrameProxy(int routing_id, int frame_routing_id);
146
lfgd64bb292016-01-18 23:57:31147 void Init(blink::WebRemoteFrame* frame,
148 RenderViewImpl* render_view,
149 RenderWidget* render_widget);
[email protected]c092f5c2014-07-18 01:34:33150
[email protected]5a7100d2014-05-19 01:29:04151 // IPC::Listener
dcheng6d18e402014-10-21 12:32:52152 bool OnMessageReceived(const IPC::Message& msg) override;
[email protected]5a7100d2014-05-19 01:29:04153
154 // IPC handlers
155 void OnDeleteProxy();
[email protected]e3244ed2014-06-20 20:04:27156 void OnChildFrameProcessGone();
[email protected]e3244ed2014-06-20 20:04:27157 void OnCompositorFrameSwapped(const IPC::Message& message);
kenrbfc7c02c92015-05-29 22:20:58158 void OnSetChildFrameSurface(const cc::SurfaceId& surface_id,
159 const gfx::Size& frame_size,
160 float scale_factor,
161 const cc::SurfaceSequence& sequence);
alexmos95733002015-08-24 16:38:09162 void OnUpdateOpener(int opener_routing_id);
nasko3e8c20e2014-12-18 06:54:56163 void OnDidStopLoading();
dcheng5f60abb2015-05-28 01:39:36164 void OnDidUpdateSandboxFlags(blink::WebSandboxFlags flags);
alexmosf40ce5b02015-02-25 20:19:56165 void OnDispatchLoad();
lukasza464d8692016-02-22 19:26:32166 void OnDidUpdateName(const std::string& name, const std::string& unique_name);
lukasza8e1c02e42016-05-17 20:05:10167 void OnAddContentSecurityPolicy(const ContentSecurityPolicyHeader& header);
168 void OnResetContentSecurityPolicy();
mkwstf672e7ef2016-06-09 20:51:07169 void OnEnforceInsecureRequestPolicy(blink::WebInsecureRequestPolicy policy);
raymesbba82b32016-07-19 00:41:38170 void OnSetFrameOwnerProperties(const FrameOwnerProperties& properties);
estarkbd8e26f2016-03-16 23:30:37171 void OnDidUpdateOrigin(const url::Origin& origin,
172 bool is_potentially_trustworthy_unique_origin);
alexmos3fcd0ca2015-10-23 18:18:33173 void OnSetPageFocus(bool is_focused);
alexmosb1dc2162015-11-05 00:59:20174 void OnSetFocusedFrame();
alexmos1f7eac4a2016-05-25 23:04:55175 void OnWillEnterFullscreen();
[email protected]e3244ed2014-06-20 20:04:27176
[email protected]c092f5c2014-07-18 01:34:33177 // The routing ID by which this RenderFrameProxy is known.
178 const int routing_id_;
[email protected]5a7100d2014-05-19 01:29:04179
[email protected]c092f5c2014-07-18 01:34:33180 // The routing ID of the local RenderFrame (if any) which this
181 // RenderFrameProxy is meant to replace in the frame tree.
182 const int frame_routing_id_;
[email protected]5a7100d2014-05-19 01:29:04183
[email protected]82307f6b2014-08-07 03:30:12184 // Stores the WebRemoteFrame we are associated with.
185 blink::WebRemoteFrame* web_frame_;
[email protected]e3244ed2014-06-20 20:04:27186 scoped_refptr<ChildFrameCompositingHelper> compositing_helper_;
187
[email protected]c092f5c2014-07-18 01:34:33188 RenderViewImpl* render_view_;
lfgd64bb292016-01-18 23:57:31189 RenderWidget* render_widget_;
[email protected]c092f5c2014-07-18 01:34:33190
[email protected]5a7100d2014-05-19 01:29:04191 DISALLOW_COPY_AND_ASSIGN(RenderFrameProxy);
192};
193
194} // namespace
195
196#endif // CONTENT_RENDERER_RENDER_FRAME_PROXY_H_