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