1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
#define CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
#include "third_party/WebKit/Source/WebKit/chromium/public/WebPlugin.h"
#include "base/memory/scoped_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/sequenced_task_runner_helpers.h"
#if defined(OS_WIN)
#include "base/shared_memory.h"
#endif
#include "content/renderer/browser_plugin/browser_plugin_backing_store.h"
#include "content/renderer/browser_plugin/browser_plugin_bindings.h"
#include "content/renderer/render_view_impl.h"
#include "third_party/WebKit/Source/WebKit/chromium/public/WebDragStatus.h"
struct BrowserPluginHostMsg_ResizeGuest_Params;
struct BrowserPluginMsg_DidNavigate_Params;
struct BrowserPluginMsg_UpdateRect_Params;
namespace content {
class BrowserPluginManager;
class MockBrowserPlugin;
class CONTENT_EXPORT BrowserPlugin :
NON_EXPORTED_BASE(public WebKit::WebPlugin) {
public:
// Called only by tests to clean up before we blow away the MockRenderProcess.
void Cleanup();
// Get the src attribute value of the BrowserPlugin instance if the guest
// has not crashed.
std::string GetSrcAttribute() const;
// Set the src attribute value of the BrowserPlugin instance and reset
// the guest_crashed_ flag.
void SetSrcAttribute(const std::string& src);
// Returns Chrome's process ID for the current guest.
int process_id() const { return process_id_; }
// The partition identifier string is stored as UTF-8.
std::string GetPartitionAttribute() const;
// Query whether the guest can navigate back to the previous entry.
bool CanGoBack() const;
// Query whether the guest can navigation forward to the next entry.
bool CanGoForward() const;
// This method can be successfully called only before the first navigation for
// this instance of BrowserPlugin. If an error occurs, the |error_message| is
// set appropriately to indicate the failure reason.
bool SetPartitionAttribute(const std::string& partition_id,
std::string& error_message);
// Inform the BrowserPlugin to update its backing store with the pixels in
// its damage buffer.
void UpdateRect(int message_id,
const BrowserPluginMsg_UpdateRect_Params& params);
// Inform the BrowserPlugin that its guest has crashed.
void GuestCrashed();
// Informs the BrowserPlugin that the guest has navigated to a new URL.
void DidNavigate(const BrowserPluginMsg_DidNavigate_Params& params);
// Inform the BrowserPlugin that the guest has started loading a new page.
void LoadStart(const GURL& url, bool is_top_level);
// Inform the BrowserPlugin that the guest has aborted loading a new page.
void LoadAbort(const GURL& url, bool is_top_level, const std::string& type);
// Inform the BrowserPlugin that the guest has redirected a navigation.
void LoadRedirect(const GURL& old_url,
const GURL& new_url,
bool is_top_level);
// Tells the BrowserPlugin to advance the focus to the next (or previous)
// element.
void AdvanceFocus(bool reverse);
// Informs the BrowserPlugin that the guest has started/stopped accepting
// touch events.
void SetAcceptTouchEvents(bool accept);
// Indicates whether there are any Javascript listeners attached to a
// provided event_name.
bool HasListeners(const std::string& event_name);
// Add a custom event listener to this BrowserPlugin instance.
bool AddEventListener(const std::string& event_name,
v8::Local<v8::Function> function);
// Remove a custom event listener from this BrowserPlugin instance.
bool RemoveEventListener(const std::string& event_name,
v8::Local<v8::Function> function);
// Tells the BrowserPlugin to tell the guest to navigate to the previous
// navigation entry in the navigation history.
void Back();
// Tells the BrowserPlugin to tell the guest to navigate to the next
// navigation entry in the navigation history.
void Forward();
// Tells the BrowserPlugin to tell the guest to navigate to a position
// relative to the current index in its navigation history.
void Go(int relativeIndex);
// Tells the BrowserPlugin to terminate the guest process.
void TerminateGuest();
// A request from Javascript has been made to stop the loading of the page.
void Stop();
// A request from Javascript has been made to reload the page.
void Reload();
// WebKit::WebPlugin implementation.
virtual WebKit::WebPluginContainer* container() const OVERRIDE;
virtual bool initialize(WebKit::WebPluginContainer* container) OVERRIDE;
virtual void destroy() OVERRIDE;
virtual NPObject* scriptableObject() OVERRIDE;
virtual bool supportsKeyboardFocus() const OVERRIDE;
virtual bool canProcessDrag() const OVERRIDE;
virtual void paint(
WebKit::WebCanvas* canvas,
const WebKit::WebRect& rect) OVERRIDE;
virtual void updateGeometry(
const WebKit::WebRect& frame_rect,
const WebKit::WebRect& clip_rect,
const WebKit::WebVector<WebKit::WebRect>& cut_outs_rects,
bool is_visible) OVERRIDE;
virtual void updateFocus(bool focused) OVERRIDE;
virtual void updateVisibility(bool visible) OVERRIDE;
virtual bool acceptsInputEvents() OVERRIDE;
virtual bool handleInputEvent(
const WebKit::WebInputEvent& event,
WebKit::WebCursorInfo& cursor_info) OVERRIDE;
virtual bool handleDragStatusUpdate(WebKit::WebDragStatus drag_status,
const WebKit::WebDragData& drag_data,
WebKit::WebDragOperationsMask mask,
const WebKit::WebPoint& position,
const WebKit::WebPoint& screen) OVERRIDE;
virtual void didReceiveResponse(
const WebKit::WebURLResponse& response) OVERRIDE;
virtual void didReceiveData(const char* data, int data_length) OVERRIDE;
virtual void didFinishLoading() OVERRIDE;
virtual void didFailLoading(const WebKit::WebURLError& error) OVERRIDE;
virtual void didFinishLoadingFrameRequest(
const WebKit::WebURL& url,
void* notify_data) OVERRIDE;
virtual void didFailLoadingFrameRequest(
const WebKit::WebURL& url,
void* notify_data,
const WebKit::WebURLError& error) OVERRIDE;
protected:
friend class base::DeleteHelper<BrowserPlugin>;
// Only the manager is allowed to create a BrowserPlugin.
friend class BrowserPluginManagerImpl;
friend class MockBrowserPluginManager;
// For unit/integration tests.
friend class MockBrowserPlugin;
// A BrowserPlugin object is a controller that represents an instance of a
// browser plugin within the embedder renderer process. Each BrowserPlugin
// within a process has a unique instance_id that is used to route messages
// to it. It takes in a RenderViewImpl that it's associated with along
// with the frame within which it lives and the initial attributes assigned
// to it on creation.
BrowserPlugin(
int instance_id,
RenderViewImpl* render_view,
WebKit::WebFrame* frame,
const WebKit::WebPluginParams& params);
virtual ~BrowserPlugin();
int width() const { return plugin_rect_.width(); }
int height() const { return plugin_rect_.height(); }
// Virtual to allow for mocking in tests.
virtual float GetDeviceScaleFactor() const;
// Parses the attributes of the browser plugin from the element's attributes
// and sets them appropriately.
void ParseAttributes(const WebKit::WebPluginParams& params);
// Returns the pending resize guest param if there is one. Returns a param
// with invalid transport dib otherwise.
BrowserPluginHostMsg_ResizeGuest_Params* GetPendingResizeParams();
// Cleanup event listener state to free v8 resources when a BrowserPlugin
// is destroyed.
void RemoveEventListeners();
// Creates and maps transport dib. Overridden in tests.
virtual TransportDIB* CreateTransportDIB(const size_t size);
// Frees up the damage buffer. Overridden in tests.
virtual void FreeDamageBuffer();
int instance_id_;
base::WeakPtr<RenderViewImpl> render_view_;
// We cache the |render_view_|'s routing ID because we need it on destruction.
// If the |render_view_| is destroyed before the BrowserPlugin is destroyed
// then we will attempt to access a NULL pointer.
int render_view_routing_id_;
WebKit::WebPluginContainer* container_;
scoped_ptr<BrowserPluginBindings> bindings_;
scoped_ptr<BrowserPluginBackingStore> backing_store_;
TransportDIB* damage_buffer_;
gfx::Rect plugin_rect_;
// Bitmap for crashed plugin. Lazily initialized, non-owning pointer.
SkBitmap* sad_guest_;
bool guest_crashed_;
bool resize_pending_;
scoped_ptr<BrowserPluginHostMsg_ResizeGuest_Params> pending_resize_params_;
// True if we have ever sent a NavigateGuest message to the embedder.
bool navigate_src_sent_;
std::string src_;
int process_id_;
std::string storage_partition_id_;
bool persist_storage_;
// Tracks the visibility of the browser plugin regardless of the whole
// embedder RenderView's visibility.
bool visible_;
typedef std::vector<v8::Persistent<v8::Function> > EventListeners;
typedef std::map<std::string, EventListeners> EventListenerMap;
EventListenerMap event_listener_map_;
#if defined(OS_WIN)
base::SharedMemory shared_memory_;
#endif
// Important: Do not add more history state here.
// We strongly discourage storing additional history state (such as page IDs)
// in the embedder process, at the risk of having incorrect information that
// can lead to broken back/forward logic in apps.
// It's also important that this state does not get modified by any logic in
// the embedder process. It should only be updated in response to navigation
// events in the guest. No assumptions should be made about how the index
// will change after a navigation (e.g., for back, forward, or go), because
// the changes are not always obvious. For example, there is a maximum
// number of entries and earlier ones will automatically be pruned.
int current_nav_entry_index_;
int nav_entry_count_;
DISALLOW_COPY_AND_ASSIGN(BrowserPlugin);
};
} // namespace content
#endif // CONTENT_RENDERER_BROWSER_PLUGIN_BROWSER_PLUGIN_H_
|
