content/renderer/render_frame_proxy.h

   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.
   4
   5 #ifndef CONTENT_RENDERER_RENDER_FRAME_PROXY_H_
   6 #define CONTENT_RENDERER_RENDER_FRAME_PROXY_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "content/common/content_export.h"
  11 #include "ipc/ipc_listener.h"
  12 #include "ipc/ipc_sender.h"
  13 #include "third_party/WebKit/public/web/WebRemoteFrame.h"
  14 #include "third_party/WebKit/public/web/WebRemoteFrameClient.h"
  15
  16 struct FrameMsg_BuffersSwapped_Params;
  17 struct FrameMsg_CompositorFrameSwapped_Params;
  18
  19 namespace blink {
  20 class WebInputEvent;
  21 }
  22
  23 namespace content {
  24
  25 class ChildFrameCompositingHelper;
  26 class RenderFrameImpl;
  27 class RenderViewImpl;
  28 enum class SandboxFlags;
  29 struct FrameReplicationState;
  30
  31 // When a page's frames are rendered by multiple processes, each renderer has a
  32 // full copy of the frame tree. It has full RenderFrames for the frames it is
  33 // responsible for rendering and placeholder objects for frames rendered by
  34 // other processes. This class is the renderer-side object for the placeholder.
  35 // RenderFrameProxy allows us to keep existing window references valid over
  36 // cross-process navigations and route cross-site asynchronous JavaScript calls,
  37 // such as postMessage.
  38 //
  39 // For now, RenderFrameProxy is created when RenderFrame is swapped out. It
  40 // acts as a wrapper and is used for sending and receiving IPC messages. It is
  41 // deleted when the RenderFrame is swapped back in or the node of the frame
  42 // tree is deleted.
  43 //
  44 // Long term, RenderFrameProxy will be created to replace the RenderFrame in the
  45 // frame tree and the RenderFrame will be deleted after its unload handler has
  46 // finished executing. It will still be responsible for routing IPC messages
  47 // which are valid for cross-site interactions between frames.
  48 // RenderFrameProxy will be deleted when the node in the frame tree is deleted
  49 // or when navigating the frame causes it to return to this process and a new
  50 // RenderFrame is created for it.
  51 class CONTENT_EXPORT RenderFrameProxy
  52     : public IPC::Listener,
  53       public IPC::Sender,
  54       NON_EXPORTED_BASE(public blink::WebRemoteFrameClient) {
  55  public:
  56   // This method should be used to create a RenderFrameProxy, which will replace
  57   // an existing RenderFrame during its cross-process navigation from the
  58   // current process to a different one. |routing_id| will be ID of the newly
  59   // created RenderFrameProxy. |frame_to_replace| is the frame that the new
  60   // proxy will eventually swap places with.
  61   static RenderFrameProxy* CreateProxyToReplaceFrame(
  62       RenderFrameImpl* frame_to_replace,
  63       int routing_id);
  64
  65   // This method should be used to create a RenderFrameProxy, when there isn't
  66   // an existing RenderFrame. It should be called to construct a local
  67   // representation of a RenderFrame that has been created in another process --
  68   // for example, after a cross-process navigation or after the addition of a
  69   // new frame local to some other process. |routing_id| will be the ID of the
  70   // newly created RenderFrameProxy. |parent_routing_id| is the routing ID of
  71   // the RenderFrameProxy to which the new frame is parented.
  72   // |render_view_routing_id| identifies the RenderView to be associated with
  73   // this frame.
  74   //
  75   // |parent_routing_id| always identifies a RenderFrameProxy (never a
  76   // RenderFrame) because a new child of a local frame should always start out
  77   // as a frame, not a proxy.
  78   static RenderFrameProxy* CreateFrameProxy(
  79       int routing_id,
  80       int parent_routing_id,
  81       int render_view_routing_id,
  82       const FrameReplicationState& replicated_state);
  83
  84   // Returns the RenderFrameProxy for the given routing ID.
  85   static RenderFrameProxy* FromRoutingID(int routing_id);
  86
  87   // Returns the RenderFrameProxy given a WebFrame.
  88   static RenderFrameProxy* FromWebFrame(blink::WebFrame* web_frame);
  89
  90   ~RenderFrameProxy() override;
  91
  92   // IPC::Sender
  93   bool Send(IPC::Message* msg) override;
  94
  95   // Out-of-process child frames receive a signal from RenderWidgetCompositor
  96   // when a compositor frame has committed.
  97   void DidCommitCompositorFrame();
  98
  99   // Pass replicated information, such as security origin, to this
 100   // RenderFrameProxy's WebRemoteFrame.
 101   void SetReplicatedState(const FrameReplicationState& state);
 102
 103   // Navigating a top-level frame cross-process does not swap the WebLocalFrame
 104   // for a WebRemoteFrame in the frame tree. In this case, this WebRemoteFrame
 105   // is not attached to the frame tree and there is no blink::Frame associated
 106   // with it, so it is not in state where most operations on it will succeed.
 107   bool IsMainFrameDetachedFromTree() const;
 108
 109   int routing_id() { return routing_id_; }
 110   RenderViewImpl* render_view() { return render_view_; }
 111   blink::WebRemoteFrame* web_frame() { return web_frame_; }
 112
 113   // blink::WebRemoteFrameClient implementation:
 114   virtual void frameDetached();
 115   virtual void postMessageEvent(
 116       blink::WebLocalFrame* sourceFrame,
 117       blink::WebRemoteFrame* targetFrame,
 118       blink::WebSecurityOrigin target,
 119       blink::WebDOMMessageEvent event);
 120   virtual void initializeChildFrame(
 121       const blink::WebRect& frame_rect,
 122       float scale_factor);
 123   virtual void navigate(const blink::WebURLRequest& request,
 124                         bool should_replace_current_entry);
 125   virtual void forwardInputEvent(const blink::WebInputEvent* event);
 126
 127   // IPC handlers
 128   void OnDidStartLoading();
 129
 130  private:
 131   RenderFrameProxy(int routing_id, int frame_routing_id);
 132
 133   void Init(blink::WebRemoteFrame* frame, RenderViewImpl* render_view);
 134
 135   // IPC::Listener
 136   bool OnMessageReceived(const IPC::Message& msg) override;
 137
 138   // IPC handlers
 139   void OnDeleteProxy();
 140   void OnChildFrameProcessGone();
 141   void OnCompositorFrameSwapped(const IPC::Message& message);
 142   void OnDisownOpener();
 143   void OnDidStopLoading();
 144   void OnDidUpdateSandboxFlags(SandboxFlags flags);
 145   void OnDispatchLoad();
 146   void OnDidUpdateName(const std::string& name);
 147
 148   // The routing ID by which this RenderFrameProxy is known.
 149   const int routing_id_;
 150
 151   // The routing ID of the local RenderFrame (if any) which this
 152   // RenderFrameProxy is meant to replace in the frame tree.
 153   const int frame_routing_id_;
 154
 155   // Stores the WebRemoteFrame we are associated with.
 156   blink::WebRemoteFrame* web_frame_;
 157   scoped_refptr<ChildFrameCompositingHelper> compositing_helper_;
 158
 159   RenderViewImpl* render_view_;
 160
 161   DISALLOW_COPY_AND_ASSIGN(RenderFrameProxy);
 162 };
 163
 164 }  // namespace
 165
 166 #endif  // CONTENT_RENDERER_RENDER_FRAME_PROXY_H_