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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
|
/*
* Copyright (C) 2010, 2012, 2015 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PluginView_h
#define PluginView_h
#include "LayerTreeContext.h"
#include "NPRuntimeObjectMap.h"
#include "Plugin.h"
#include "PluginController.h"
#include "WebFrame.h"
#include <WebCore/FindOptions.h>
#include <WebCore/Image.h>
#include <WebCore/MediaCanStartListener.h>
#include <WebCore/MediaProducer.h>
#include <WebCore/PluginViewBase.h>
#include <WebCore/ResourceError.h>
#include <WebCore/ResourceResponse.h>
#include <WebCore/Timer.h>
#include <WebCore/ViewState.h>
#include <memory>
#include <wtf/Deque.h>
#include <wtf/RunLoop.h>
// FIXME: Eventually this should move to WebCore.
#if PLATFORM(COCOA)
OBJC_CLASS NSDictionary;
OBJC_CLASS PDFSelection;
#endif
namespace WebCore {
class Frame;
class HTMLPlugInElement;
class MachSendRight;
class MouseEvent;
}
namespace WebKit {
class WebEvent;
class PluginView : public WebCore::PluginViewBase, public PluginController, private WebCore::MediaCanStartListener, private WebFrame::LoadListener, private WebCore::MediaProducer {
public:
static Ref<PluginView> create(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters&);
void recreateAndInitialize(PassRefPtr<Plugin>);
WebCore::Frame* frame() const;
bool isBeingDestroyed() const { return m_isBeingDestroyed; }
void manualLoadDidReceiveResponse(const WebCore::ResourceResponse&);
void manualLoadDidReceiveData(const char* bytes, int length);
void manualLoadDidFinishLoading();
void manualLoadDidFail(const WebCore::ResourceError&);
void viewStateDidChange(WebCore::ViewState::Flags changed);
void setLayerHostingMode(LayerHostingMode);
#if PLATFORM(COCOA)
void setDeviceScaleFactor(float);
void windowAndViewFramesChanged(const WebCore::FloatRect& windowFrameInScreenCoordinates, const WebCore::FloatRect& viewFrameInWindowCoordinates);
bool sendComplexTextInput(uint64_t pluginComplexTextInputIdentifier, const String& textInput);
RetainPtr<PDFDocument> pdfDocumentForPrinting() const { return m_plugin->pdfDocumentForPrinting(); }
NSObject *accessibilityObject() const;
#endif
WebCore::HTMLPlugInElement* pluginElement() const { return m_pluginElement.get(); }
const Plugin::Parameters& initialParameters() const { return m_parameters; }
Plugin* plugin() const { return m_plugin.get(); }
void setPageScaleFactor(double scaleFactor, WebCore::IntPoint origin);
double pageScaleFactor() const;
bool handlesPageScaleFactor() const;
bool requiresUnifiedScaleFactor() const;
void pageScaleFactorDidChange();
void topContentInsetDidChange();
void webPageDestroyed();
bool handleEditingCommand(const String& commandName, const String& argument);
bool isEditingCommandEnabled(const String& commandName);
unsigned countFindMatches(const String& target, WebCore::FindOptions, unsigned maxMatchCount);
bool findString(const String& target, WebCore::FindOptions, unsigned maxMatchCount);
String getSelectionString() const;
bool shouldAllowScripting();
PassRefPtr<WebCore::SharedBuffer> liveResourceData() const;
bool performDictionaryLookupAtLocation(const WebCore::FloatPoint&);
String getSelectionForWordAtPoint(const WebCore::FloatPoint&) const;
bool existingSelectionContainsPoint(const WebCore::FloatPoint&) const;
virtual WebCore::AudioHardwareActivityType audioHardwareActivity() const override;
private:
PluginView(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters& parameters);
virtual ~PluginView();
void initializePlugin();
void viewGeometryDidChange();
void viewVisibilityDidChange();
WebCore::IntRect clipRectInWindowCoordinates() const;
void focusPluginElement();
void pendingURLRequestsTimerFired();
class URLRequest;
void performURLRequest(URLRequest*);
// Perform a URL request where the frame target is not null.
void performFrameLoadURLRequest(URLRequest*);
// Perform a URL request where the URL protocol is "javascript:".
void performJavaScriptURLRequest(URLRequest*);
class Stream;
void addStream(Stream*);
void removeStream(Stream*);
void cancelAllStreams();
void redeliverManualStream();
void pluginSnapshotTimerFired();
void pluginDidReceiveUserInteraction();
bool shouldCreateTransientPaintingSnapshot() const;
// WebCore::PluginViewBase
#if PLATFORM(COCOA)
virtual PlatformLayer* platformLayer() const override;
#endif
virtual JSC::JSObject* scriptObject(JSC::JSGlobalObject*) override;
virtual void storageBlockingStateChanged() override;
virtual void privateBrowsingStateChanged(bool) override;
virtual bool getFormValue(String&) override;
virtual bool scroll(WebCore::ScrollDirection, WebCore::ScrollGranularity) override;
virtual WebCore::Scrollbar* horizontalScrollbar() override;
virtual WebCore::Scrollbar* verticalScrollbar() override;
virtual bool wantsWheelEvents() override;
virtual bool shouldAlwaysAutoStart() const override;
virtual void beginSnapshottingRunningPlugin() override;
virtual bool shouldAllowNavigationFromDrags() const override;
virtual bool shouldNotAddLayer() const override;
virtual void willDetatchRenderer() override;
// WebCore::Widget
virtual void setFrameRect(const WebCore::IntRect&) override;
virtual void paint(WebCore::GraphicsContext&, const WebCore::IntRect&) override;
virtual void invalidateRect(const WebCore::IntRect&) override;
virtual void setFocus(bool) override;
virtual void frameRectsChanged() override;
virtual void setParent(WebCore::ScrollView*) override;
virtual void handleEvent(WebCore::Event*) override;
virtual void notifyWidget(WebCore::WidgetNotification) override;
virtual void show() override;
virtual void hide() override;
virtual void setParentVisible(bool) override;
virtual bool transformsAffectFrameRect() override;
virtual void clipRectChanged() override;
// WebCore::MediaCanStartListener
virtual void mediaCanStart() override;
// WebCore::MediaProducer
virtual MediaProducer::MediaStateFlags mediaState() const override { return m_pluginIsPlayingAudio ? MediaProducer::IsPlayingAudio : MediaProducer::IsNotPlaying; }
virtual void pageMutedStateDidChange() override;
// PluginController
virtual void invalidate(const WebCore::IntRect&) override;
virtual String userAgent() override;
virtual void loadURL(uint64_t requestID, const String& method, const String& urlString, const String& target, const WebCore::HTTPHeaderMap& headerFields, const Vector<uint8_t>& httpBody, bool allowPopups) override;
virtual void cancelStreamLoad(uint64_t streamID) override;
virtual void continueStreamLoad(uint64_t streamID) override;
virtual void cancelManualStreamLoad() override;
#if ENABLE(NETSCAPE_PLUGIN_API)
virtual NPObject* windowScriptNPObject() override;
virtual NPObject* pluginElementNPObject() override;
virtual bool evaluate(NPObject*, const String& scriptString, NPVariant* result, bool allowPopups) override;
virtual void setPluginIsPlayingAudio(bool) override;
virtual bool isMuted() const override;
#endif
virtual void setStatusbarText(const String&) override;
virtual bool isAcceleratedCompositingEnabled() override;
virtual void pluginProcessCrashed() override;
#if PLATFORM(COCOA)
virtual void pluginFocusOrWindowFocusChanged(bool pluginHasFocusAndWindowHasFocus) override;
virtual void setComplexTextInputState(PluginComplexTextInputState) override;
virtual const WebCore::MachSendRight& compositingRenderServerPort() override;
#endif
virtual float contentsScaleFactor() override;
virtual String proxiesForURL(const String&) override;
virtual String cookiesForURL(const String&) override;
virtual void setCookiesForURL(const String& urlString, const String& cookieString) override;
virtual bool getAuthenticationInfo(const WebCore::ProtectionSpace&, String& username, String& password) override;
virtual bool isPrivateBrowsingEnabled() override;
virtual bool asynchronousPluginInitializationEnabled() const override;
virtual bool asynchronousPluginInitializationEnabledForAllPlugins() const override;
virtual bool artificialPluginInitializationDelayEnabled() const override;
virtual void protectPluginFromDestruction() override;
virtual void unprotectPluginFromDestruction() override;
#if PLUGIN_ARCHITECTURE(X11)
virtual uint64_t createPluginContainer() override;
virtual void windowedPluginGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect, uint64_t windowID) override;
virtual void windowedPluginVisibilityDidChange(bool isVisible, uint64_t windowID) override;
#endif
virtual void didInitializePlugin() override;
virtual void didFailToInitializePlugin() override;
void destroyPluginAndReset();
// WebFrame::LoadListener
virtual void didFinishLoad(WebFrame*) override;
virtual void didFailLoad(WebFrame*, bool wasCancelled) override;
std::unique_ptr<WebEvent> createWebEvent(WebCore::MouseEvent*) const;
RefPtr<WebCore::HTMLPlugInElement> m_pluginElement;
RefPtr<Plugin> m_plugin;
WebPage* m_webPage;
Plugin::Parameters m_parameters;
bool m_isInitialized;
bool m_isWaitingForSynchronousInitialization;
bool m_isWaitingUntilMediaCanStart;
bool m_isBeingDestroyed;
bool m_pluginProcessHasCrashed;
#if ENABLE(PRIMARY_SNAPSHOTTED_PLUGIN_HEURISTIC)
bool m_didPlugInStartOffScreen;
#endif
// Pending URLRequests that the plug-in has made.
Deque<RefPtr<URLRequest>> m_pendingURLRequests;
RunLoop::Timer<PluginView> m_pendingURLRequestsTimer;
// Pending frame loads that the plug-in has made.
typedef HashMap<RefPtr<WebFrame>, RefPtr<URLRequest>> FrameLoadMap;
FrameLoadMap m_pendingFrameLoads;
// Streams that the plug-in has requested to load.
HashMap<uint64_t, RefPtr<Stream>> m_streams;
#if ENABLE(NETSCAPE_PLUGIN_API)
// A map of all related NPObjects for this plug-in view.
NPRuntimeObjectMap m_npRuntimeObjectMap;
#endif
// The manual stream state. This is used so we can deliver a manual stream to a plug-in
// when it is initialized.
enum ManualStreamState {
StreamStateInitial,
StreamStateHasReceivedResponse,
StreamStateFinished,
StreamStateFailed
};
ManualStreamState m_manualStreamState;
WebCore::ResourceResponse m_manualStreamResponse;
WebCore::ResourceError m_manualStreamError;
RefPtr<WebCore::SharedBuffer> m_manualStreamData;
// This snapshot is used to avoid side effects should the plugin run JS during painting.
RefPtr<ShareableBitmap> m_transientPaintingSnapshot;
// This timer is used when plugin snapshotting is enabled, to capture a plugin placeholder.
WebCore::DeferrableOneShotTimer m_pluginSnapshotTimer;
#if ENABLE(PRIMARY_SNAPSHOTTED_PLUGIN_HEURISTIC) || PLATFORM(COCOA)
unsigned m_countSnapshotRetries;
#endif
bool m_didReceiveUserInteraction;
double m_pageScaleFactor;
bool m_pluginIsPlayingAudio;
};
} // namespace WebKit
#endif // PluginView_h
|
