blob: 1ce026460147c563381e1845889afb0fbae11ca2 [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"
[email protected]5a7100d2014-05-19 01:29:0414#include "third_party/WebKit/public/web/WebRemoteFrame.h"
japhet4dad341e2014-09-09 21:11:1115#include "third_party/WebKit/public/web/WebRemoteFrameClient.h"
mkwst13213f32015-07-27 07:06:2716#include "url/origin.h"
[email protected]5a7100d2014-05-19 01:29:0417
[email protected]e3244ed2014-06-20 20:04:2718struct FrameMsg_BuffersSwapped_Params;
19struct FrameMsg_CompositorFrameSwapped_Params;
20
creis5834fe5e2014-10-10 21:50:4921namespace blink {
22class WebInputEvent;
lazyboy0882dfce2015-08-16 05:47:3823struct WebRect;
creis5834fe5e2014-10-10 21:50:4924}
25
kenrbfc7c02c92015-05-29 22:20:5826namespace cc {
27struct SurfaceId;
28struct SurfaceSequence;
29}
30
[email protected]5a7100d2014-05-19 01:29:0431namespace content {
32
[email protected]e3244ed2014-06-20 20:04:2733class ChildFrameCompositingHelper;
[email protected]5a7100d2014-05-19 01:29:0434class RenderFrameImpl;
35class RenderViewImpl;
alexmosbc7eafa2014-12-06 01:38:0936struct FrameReplicationState;
[email protected]5a7100d2014-05-19 01:29:0437
38// When a page's frames are rendered by multiple processes, each renderer has a
39// full copy of the frame tree. It has full RenderFrames for the frames it is
40// responsible for rendering and placeholder objects for frames rendered by
41// other processes. This class is the renderer-side object for the placeholder.
42// RenderFrameProxy allows us to keep existing window references valid over
43// cross-process navigations and route cross-site asynchronous JavaScript calls,
44// such as postMessage.
45//
46// For now, RenderFrameProxy is created when RenderFrame is swapped out. It
47// acts as a wrapper and is used for sending and receiving IPC messages. It is
48// deleted when the RenderFrame is swapped back in or the node of the frame
49// tree is deleted.
50//
51// Long term, RenderFrameProxy will be created to replace the RenderFrame in the
52// frame tree and the RenderFrame will be deleted after its unload handler has
53// finished executing. It will still be responsible for routing IPC messages
54// which are valid for cross-site interactions between frames.
55// RenderFrameProxy will be deleted when the node in the frame tree is deleted
56// or when navigating the frame causes it to return to this process and a new
57// RenderFrame is created for it.
58class CONTENT_EXPORT RenderFrameProxy
59 : public IPC::Listener,
60 public IPC::Sender,
japhet4dad341e2014-09-09 21:11:1161 NON_EXPORTED_BASE(public blink::WebRemoteFrameClient) {
[email protected]5a7100d2014-05-19 01:29:0462 public:
[email protected]c092f5c2014-07-18 01:34:3363 // This method should be used to create a RenderFrameProxy, which will replace
64 // an existing RenderFrame during its cross-process navigation from the
65 // current process to a different one. |routing_id| will be ID of the newly
66 // created RenderFrameProxy. |frame_to_replace| is the frame that the new
67 // proxy will eventually swap places with.
68 static RenderFrameProxy* CreateProxyToReplaceFrame(
69 RenderFrameImpl* frame_to_replace,
dcheng860817a2015-05-22 03:16:5670 int routing_id,
71 blink::WebTreeScopeType scope);
[email protected]c092f5c2014-07-18 01:34:3372
73 // This method should be used to create a RenderFrameProxy, when there isn't
74 // an existing RenderFrame. It should be called to construct a local
75 // representation of a RenderFrame that has been created in another process --
76 // for example, after a cross-process navigation or after the addition of a
77 // new frame local to some other process. |routing_id| will be the ID of the
alexmosa181efc2015-09-03 00:39:0478 // newly created RenderFrameProxy. |render_view_routing_id| identifies the
79 // RenderView to be associated with this frame. |opener_routing_id|, if
80 // valid, is the routing ID of the new frame's opener. |parent_routing_id|
81 // is the routing ID of the RenderFrameProxy to which the new frame is
82 // 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,
alexmosa181efc2015-09-03 00:39:0490 int opener_routing_id,
91 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
106 // when a compositor frame has committed.
107 void DidCommitCompositorFrame();
108
alexmosbc7eafa2014-12-06 01:38:09109 // Pass replicated information, such as security origin, to this
110 // RenderFrameProxy's WebRemoteFrame.
111 void SetReplicatedState(const FrameReplicationState& state);
112
alexmose7da5a12015-04-09 02:22:16113 // Navigating a top-level frame cross-process does not swap the WebLocalFrame
114 // for a WebRemoteFrame in the frame tree. In this case, this WebRemoteFrame
115 // is not attached to the frame tree and there is no blink::Frame associated
116 // with it, so it is not in state where most operations on it will succeed.
117 bool IsMainFrameDetachedFromTree() const;
118
[email protected]82307f6b2014-08-07 03:30:12119 int routing_id() { return routing_id_; }
120 RenderViewImpl* render_view() { return render_view_; }
121 blink::WebRemoteFrame* web_frame() { return web_frame_; }
[email protected]c092f5c2014-07-18 01:34:33122
japhet4dad341e2014-09-09 21:11:11123 // blink::WebRemoteFrameClient implementation:
avi5c77d212015-09-25 20:08:25124 void frameDetached(DetachType type) override;
125 void postMessageEvent(blink::WebLocalFrame* sourceFrame,
126 blink::WebRemoteFrame* targetFrame,
127 blink::WebSecurityOrigin target,
128 blink::WebDOMMessageEvent event) override;
129 void initializeChildFrame(const blink::WebRect& frame_rect,
130 float scale_factor) override;
131 void navigate(const blink::WebURLRequest& request,
132 bool should_replace_current_entry) override;
133 void forwardInputEvent(const blink::WebInputEvent* event) override;
134 void frameRectsChanged(const blink::WebRect& frame_rect) override;
ekaramadbabb9bf2016-01-12 15:17:02135 void visibilityChanged(bool visible) 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
[email protected]82307f6b2014-08-07 03:30:12147 void Init(blink::WebRemoteFrame* frame, RenderViewImpl* render_view);
[email protected]c092f5c2014-07-18 01:34:33148
[email protected]5a7100d2014-05-19 01:29:04149 // IPC::Listener
dcheng6d18e402014-10-21 12:32:52150 bool OnMessageReceived(const IPC::Message& msg) override;
[email protected]5a7100d2014-05-19 01:29:04151
152 // IPC handlers
153 void OnDeleteProxy();
[email protected]e3244ed2014-06-20 20:04:27154 void OnChildFrameProcessGone();
[email protected]e3244ed2014-06-20 20:04:27155 void OnCompositorFrameSwapped(const IPC::Message& message);
kenrbfc7c02c92015-05-29 22:20:58156 void OnSetChildFrameSurface(const cc::SurfaceId& surface_id,
157 const gfx::Size& frame_size,
158 float scale_factor,
159 const cc::SurfaceSequence& sequence);
alexmos95733002015-08-24 16:38:09160 void OnUpdateOpener(int opener_routing_id);
nasko3e8c20e2014-12-18 06:54:56161 void OnDidStopLoading();
dcheng5f60abb2015-05-28 01:39:36162 void OnDidUpdateSandboxFlags(blink::WebSandboxFlags flags);
alexmosf40ce5b02015-02-25 20:19:56163 void OnDispatchLoad();
alexmosbe2f4c32015-03-10 02:30:23164 void OnDidUpdateName(const std::string& name);
estarka886b8d2015-12-18 21:53:08165 void OnEnforceStrictMixedContentChecking(bool should_enforce);
mkwst13213f32015-07-27 07:06:27166 void OnDidUpdateOrigin(const url::Origin& origin);
alexmos3fcd0ca2015-10-23 18:18:33167 void OnSetPageFocus(bool is_focused);
alexmosb1dc2162015-11-05 00:59:20168 void OnSetFocusedFrame();
[email protected]e3244ed2014-06-20 20:04:27169
[email protected]c092f5c2014-07-18 01:34:33170 // The routing ID by which this RenderFrameProxy is known.
171 const int routing_id_;
[email protected]5a7100d2014-05-19 01:29:04172
[email protected]c092f5c2014-07-18 01:34:33173 // The routing ID of the local RenderFrame (if any) which this
174 // RenderFrameProxy is meant to replace in the frame tree.
175 const int frame_routing_id_;
[email protected]5a7100d2014-05-19 01:29:04176
[email protected]82307f6b2014-08-07 03:30:12177 // Stores the WebRemoteFrame we are associated with.
178 blink::WebRemoteFrame* web_frame_;
[email protected]e3244ed2014-06-20 20:04:27179 scoped_refptr<ChildFrameCompositingHelper> compositing_helper_;
180
[email protected]c092f5c2014-07-18 01:34:33181 RenderViewImpl* render_view_;
182
[email protected]5a7100d2014-05-19 01:29:04183 DISALLOW_COPY_AND_ASSIGN(RenderFrameProxy);
184};
185
186} // namespace
187
188#endif // CONTENT_RENDERER_RENDER_FRAME_PROXY_H_