1 // 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.
5 #include "content/renderer/render_frame_proxy.h"
9 #include "base/lazy_instance.h"
10 #include "content/child/webmessageportchannel_impl.h"
11 #include "content/common/frame_messages.h"
12 #include "content/common/swapped_out_messages.h"
13 #include "content/common/view_messages.h"
14 #include "content/renderer/child_frame_compositing_helper.h"
15 #include "content/renderer/render_frame_impl.h"
16 #include "content/renderer/render_thread_impl.h"
17 #include "content/renderer/render_view_impl.h"
18 #include "third_party/WebKit/public/web/WebLocalFrame.h"
19 #include "third_party/WebKit/public/web/WebUserGestureIndicator.h"
20 #include "third_party/WebKit/public/web/WebView.h"
26 // Facilitates lookup of RenderFrameProxy by routing_id.
27 typedef std::map<int, RenderFrameProxy*> RoutingIDProxyMap;
28 static base::LazyInstance<RoutingIDProxyMap> g_routing_id_proxy_map =
29 LAZY_INSTANCE_INITIALIZER;
31 // Facilitates lookup of RenderFrameProxy by WebFrame.
32 typedef std::map<blink::WebFrame*, RenderFrameProxy*> FrameMap;
33 base::LazyInstance<FrameMap> g_frame_map = LAZY_INSTANCE_INITIALIZER;
38 RenderFrameProxy* RenderFrameProxy::CreateProxyToReplaceFrame(
39 RenderFrameImpl* frame_to_replace,
41 CHECK_NE(routing_id, MSG_ROUTING_NONE);
43 scoped_ptr<RenderFrameProxy> proxy(
44 new RenderFrameProxy(routing_id, frame_to_replace->GetRoutingID()));
46 // When a RenderFrame is replaced by a RenderProxy, the WebRemoteFrame should
47 // always come from WebRemoteFrame::create and a call to WebFrame::swap must
49 blink::WebRemoteFrame* web_frame = blink::WebRemoteFrame::create(proxy.get());
50 proxy->Init(web_frame, frame_to_replace->render_view());
51 return proxy.release();
54 RenderFrameProxy* RenderFrameProxy::CreateFrameProxy(
56 int parent_routing_id,
57 int render_view_routing_id) {
58 scoped_ptr<RenderFrameProxy> proxy(
59 new RenderFrameProxy(routing_id, MSG_ROUTING_NONE));
60 RenderViewImpl* render_view = NULL;
61 blink::WebRemoteFrame* web_frame = NULL;
62 if (parent_routing_id == MSG_ROUTING_NONE) {
63 // Create a top level frame.
64 render_view = RenderViewImpl::FromRoutingID(render_view_routing_id);
65 web_frame = blink::WebRemoteFrame::create(proxy.get());
66 render_view->webview()->setMainFrame(web_frame);
68 // Create a frame under an existing parent. The parent is always expected
69 // to be a RenderFrameProxy, because navigations initiated by local frames
70 // should not wind up here.
71 RenderFrameProxy* parent =
72 RenderFrameProxy::FromRoutingID(parent_routing_id);
73 web_frame = parent->web_frame()->createRemoteChild("", proxy.get());
74 render_view = parent->render_view();
77 proxy->Init(web_frame, render_view);
79 return proxy.release();
83 RenderFrameProxy* RenderFrameProxy::FromRoutingID(int32 routing_id) {
84 RoutingIDProxyMap* proxies = g_routing_id_proxy_map.Pointer();
85 RoutingIDProxyMap::iterator it = proxies->find(routing_id);
86 return it == proxies->end() ? NULL : it->second;
90 RenderFrameProxy* RenderFrameProxy::FromWebFrame(blink::WebFrame* web_frame) {
91 FrameMap::iterator iter = g_frame_map.Get().find(web_frame);
92 if (iter != g_frame_map.Get().end()) {
93 RenderFrameProxy* proxy = iter->second;
94 DCHECK_EQ(web_frame, proxy->web_frame());
100 RenderFrameProxy::RenderFrameProxy(int routing_id, int frame_routing_id)
101 : routing_id_(routing_id),
102 frame_routing_id_(frame_routing_id),
105 std::pair<RoutingIDProxyMap::iterator, bool> result =
106 g_routing_id_proxy_map.Get().insert(std::make_pair(routing_id_, this));
107 CHECK(result.second) << "Inserting a duplicate item.";
108 RenderThread::Get()->AddRoute(routing_id_, this);
111 RenderFrameProxy::~RenderFrameProxy() {
112 render_view()->UnregisterRenderFrameProxy(this);
114 FrameMap::iterator it = g_frame_map.Get().find(web_frame_);
115 CHECK(it != g_frame_map.Get().end());
116 CHECK_EQ(it->second, this);
117 g_frame_map.Get().erase(it);
119 RenderThread::Get()->RemoveRoute(routing_id_);
120 g_routing_id_proxy_map.Get().erase(routing_id_);
123 void RenderFrameProxy::Init(blink::WebRemoteFrame* web_frame,
124 RenderViewImpl* render_view) {
128 web_frame_ = web_frame;
129 render_view_ = render_view;
131 // TODO(nick): Should all RenderFrameProxies remain observers of their views?
132 render_view_->RegisterRenderFrameProxy(this);
134 std::pair<FrameMap::iterator, bool> result =
135 g_frame_map.Get().insert(std::make_pair(web_frame_, this));
136 CHECK(result.second) << "Inserted a duplicate item.";
139 void RenderFrameProxy::DidCommitCompositorFrame() {
140 if (compositing_helper_.get())
141 compositing_helper_->DidCommitCompositorFrame();
144 bool RenderFrameProxy::OnMessageReceived(const IPC::Message& msg) {
146 IPC_BEGIN_MESSAGE_MAP(RenderFrameProxy, msg)
147 IPC_MESSAGE_HANDLER(FrameMsg_DeleteProxy, OnDeleteProxy)
148 IPC_MESSAGE_HANDLER(FrameMsg_ChildFrameProcessGone, OnChildFrameProcessGone)
149 IPC_MESSAGE_HANDLER_GENERIC(FrameMsg_CompositorFrameSwapped,
150 OnCompositorFrameSwapped(msg))
151 IPC_MESSAGE_HANDLER(FrameMsg_DisownOpener, OnDisownOpener)
152 IPC_MESSAGE_UNHANDLED(handled = false)
153 IPC_END_MESSAGE_MAP()
155 // If |handled| is true, |this| may have been deleted.
159 RenderFrameImpl* render_frame =
160 RenderFrameImpl::FromRoutingID(frame_routing_id_);
161 return render_frame && render_frame->OnMessageReceived(msg);
164 bool RenderFrameProxy::Send(IPC::Message* message) {
165 if (!SwappedOutMessages::CanSendWhileSwappedOut(message)) {
169 message->set_routing_id(routing_id_);
170 return RenderThread::Get()->Send(message);
173 void RenderFrameProxy::OnDeleteProxy() {
174 DCHECK(web_frame_->isWebRemoteFrame());
175 web_frame_->detach();
178 void RenderFrameProxy::OnChildFrameProcessGone() {
179 if (compositing_helper_.get())
180 compositing_helper_->ChildFrameGone();
183 void RenderFrameProxy::OnCompositorFrameSwapped(const IPC::Message& message) {
184 FrameMsg_CompositorFrameSwapped::Param param;
185 if (!FrameMsg_CompositorFrameSwapped::Read(&message, ¶m))
188 scoped_ptr<cc::CompositorFrame> frame(new cc::CompositorFrame);
189 param.a.frame.AssignTo(frame.get());
191 if (!compositing_helper_.get()) {
192 compositing_helper_ =
193 ChildFrameCompositingHelper::CreateForRenderFrameProxy(this);
194 compositing_helper_->EnableCompositing(true);
196 compositing_helper_->OnCompositorFrameSwapped(frame.Pass(),
197 param.a.producing_route_id,
198 param.a.output_surface_id,
199 param.a.producing_host_id,
200 param.a.shared_memory_handle);
203 void RenderFrameProxy::OnDisownOpener() {
204 // TODO(creis): We should only see this for main frames for now. To support
205 // disowning the opener on subframes, we will need to move WebContentsImpl's
206 // opener_ to FrameTreeNode.
207 CHECK(!web_frame_->parent());
209 // When there is a RenderFrame for this proxy, tell it to disown its opener.
210 // TODO(creis): Remove this when we only have WebRemoteFrames and make sure
211 // they know they have an opener.
212 RenderFrameImpl* render_frame =
213 RenderFrameImpl::FromRoutingID(frame_routing_id_);
215 if (render_frame->GetWebFrame()->opener())
216 render_frame->GetWebFrame()->setOpener(NULL);
220 if (web_frame_->opener())
221 web_frame_->setOpener(NULL);
224 void RenderFrameProxy::frameDetached() {
225 if (web_frame_->parent())
226 web_frame_->parent()->removeChild(web_frame_);
232 void RenderFrameProxy::postMessageEvent(
233 blink::WebLocalFrame* source_frame,
234 blink::WebRemoteFrame* target_frame,
235 blink::WebSecurityOrigin target_origin,
236 blink::WebDOMMessageEvent event) {
237 DCHECK(!web_frame_ || web_frame_ == target_frame);
239 ViewMsg_PostMessage_Params params;
240 params.is_data_raw_string = false;
241 params.data = event.data().toString();
242 params.source_origin = event.origin();
243 if (!target_origin.isNull())
244 params.target_origin = target_origin.toString();
246 blink::WebMessagePortChannelArray channels = event.releaseChannels();
247 if (!channels.isEmpty()) {
248 std::vector<int> message_port_ids(channels.size());
249 // Extract the port IDs from the channel array.
250 for (size_t i = 0; i < channels.size(); ++i) {
251 WebMessagePortChannelImpl* webchannel =
252 static_cast<WebMessagePortChannelImpl*>(channels[i]);
253 message_port_ids[i] = webchannel->message_port_id();
254 webchannel->QueueMessages();
255 DCHECK_NE(message_port_ids[i], MSG_ROUTING_NONE);
257 params.message_port_ids = message_port_ids;
260 // Include the routing ID for the source frame (if one exists), which the
261 // browser process will translate into the routing ID for the equivalent
262 // frame in the target process.
263 params.source_routing_id = MSG_ROUTING_NONE;
265 RenderViewImpl* source_view =
266 RenderViewImpl::FromWebView(source_frame->view());
268 params.source_routing_id = source_view->routing_id();
271 Send(new ViewHostMsg_RouteMessageEvent(render_view_->GetRoutingID(), params));
274 void RenderFrameProxy::initializeChildFrame(
275 const blink::WebRect& frame_rect,
276 float scale_factor) {
277 Send(new FrameHostMsg_InitializeChildFrame(
278 routing_id_, frame_rect, scale_factor));
281 void RenderFrameProxy::navigate(const blink::WebURLRequest& request,
282 bool should_replace_current_entry) {
283 FrameHostMsg_OpenURL_Params params;
284 params.url = request.url();
285 params.referrer = Referrer(
286 GURL(request.httpHeaderField(blink::WebString::fromUTF8("Referer"))),
287 request.referrerPolicy());
288 params.disposition = CURRENT_TAB;
289 params.should_replace_current_entry = should_replace_current_entry;
290 params.user_gesture =
291 blink::WebUserGestureIndicator::isProcessingUserGesture();
292 blink::WebUserGestureIndicator::consumeUserGesture();
293 Send(new FrameHostMsg_OpenURL(routing_id_, params));
296 void RenderFrameProxy::forwardInputEvent(const blink::WebInputEvent* event) {
297 Send(new FrameHostMsg_ForwardInputEvent(routing_id_, event));