Plugins that resize might need to be snapshotted.
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / PluginView.h
1 /*
2  * Copyright (C) 2010, 2012 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef PluginView_h
27 #define PluginView_h
28
29 #include "NPRuntimeObjectMap.h"
30 #include "Plugin.h"
31 #include "PluginController.h"
32 #include "WebFrame.h"
33 #include <WebCore/FindOptions.h>
34 #include <WebCore/Image.h>
35 #include <WebCore/MediaCanStartListener.h>
36 #include <WebCore/PluginViewBase.h>
37 #include <WebCore/ResourceError.h>
38 #include <WebCore/ResourceResponse.h>
39 #include <WebCore/RunLoop.h>
40 #include <WebCore/Timer.h>
41 #include <wtf/Deque.h>
42
43 // FIXME: Eventually this should move to WebCore.
44
45 namespace WebCore {
46 class Frame;
47 class HTMLPlugInElement;
48 class MouseEvent;
49 class RenderBoxModelObject;
50 }
51
52 namespace WebKit {
53
54 class WebEvent;
55
56 class PluginView : public WebCore::PluginViewBase, public PluginController, private WebCore::MediaCanStartListener, private WebFrame::LoadListener {
57 public:
58     static PassRefPtr<PluginView> create(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters&);
59
60     void recreateAndInitialize(PassRefPtr<Plugin>);
61
62     WebCore::Frame* frame() const;
63
64     bool isBeingDestroyed() const { return m_isBeingDestroyed; }
65
66     void manualLoadDidReceiveResponse(const WebCore::ResourceResponse&);
67     void manualLoadDidReceiveData(const char* bytes, int length);
68     void manualLoadDidFinishLoading();
69     void manualLoadDidFail(const WebCore::ResourceError&);
70
71 #if PLATFORM(MAC)
72     void setWindowIsVisible(bool);
73     void setWindowIsFocused(bool);
74     void setDeviceScaleFactor(float);
75     void windowAndViewFramesChanged(const WebCore::FloatRect& windowFrameInScreenCoordinates, const WebCore::FloatRect& viewFrameInWindowCoordinates);
76     bool sendComplexTextInput(uint64_t pluginComplexTextInputIdentifier, const String& textInput);
77     void setLayerHostingMode(LayerHostingMode);
78     RetainPtr<PDFDocument> pdfDocumentForPrinting() const { return m_plugin->pdfDocumentForPrinting(); }
79 #endif
80
81     WebCore::HTMLPlugInElement* pluginElement() const { return m_pluginElement.get(); }
82     const Plugin::Parameters& initialParameters() const { return m_parameters; }
83
84     // FIXME: Remove this; nobody should have to know about the plug-in view's renderer except the plug-in view itself.
85     WebCore::RenderBoxModelObject* renderer() const;
86     
87     void setPageScaleFactor(double scaleFactor, WebCore::IntPoint origin);
88     double pageScaleFactor();
89     bool handlesPageScaleFactor() { return m_plugin->handlesPageScaleFactor(); }
90
91     void pageScaleFactorDidChange();
92     void webPageDestroyed();
93
94     bool handleEditingCommand(const String& commandName, const String& argument);
95     bool isEditingCommandEnabled(const String& commandName);
96     
97     unsigned countFindMatches(const String& target, WebCore::FindOptions, unsigned maxMatchCount);
98     bool findString(const String& target, WebCore::FindOptions, unsigned maxMatchCount);
99
100     String getSelectionString() const;
101
102     bool shouldAllowScripting();
103
104     PassRefPtr<WebCore::SharedBuffer> liveResourceData() const;
105     bool performDictionaryLookupAtLocation(const WebCore::FloatPoint&);
106
107 private:
108     PluginView(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters& parameters);
109     virtual ~PluginView();
110
111     void initializePlugin();
112
113     void viewGeometryDidChange();
114     void viewVisibilityDidChange();
115     WebCore::IntRect clipRectInWindowCoordinates() const;
116     void focusPluginElement();
117     
118     void pendingURLRequestsTimerFired();
119     class URLRequest;
120     void performURLRequest(URLRequest*);
121
122     // Perform a URL request where the frame target is not null.
123     void performFrameLoadURLRequest(URLRequest*);
124
125     // Perform a URL request where the URL protocol is "javascript:".
126     void performJavaScriptURLRequest(URLRequest*);
127
128     class Stream;
129     void addStream(Stream*);
130     void removeStream(Stream*);
131     void cancelAllStreams();
132
133     void redeliverManualStream();
134
135     void pluginSnapshotTimerFired(WebCore::DeferrableOneShotTimer<PluginView>*);
136     void pluginDidReceiveUserInteraction();
137
138     // WebCore::PluginViewBase
139 #if PLATFORM(MAC)
140     virtual PlatformLayer* platformLayer() const;
141 #endif
142     virtual JSC::JSObject* scriptObject(JSC::JSGlobalObject*);
143     virtual void storageBlockingStateChanged();
144     virtual void privateBrowsingStateChanged(bool);
145     virtual bool getFormValue(String&);
146     virtual bool scroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
147     virtual WebCore::Scrollbar* horizontalScrollbar();
148     virtual WebCore::Scrollbar* verticalScrollbar();
149     virtual bool wantsWheelEvents();
150     virtual bool shouldAlwaysAutoStart() const OVERRIDE;
151     virtual void beginSnapshottingRunningPlugin() OVERRIDE;
152     virtual bool shouldAllowNavigationFromDrags() const OVERRIDE;
153
154     // WebCore::Widget
155     virtual void setFrameRect(const WebCore::IntRect&);
156     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect&);
157     virtual void invalidateRect(const WebCore::IntRect&);
158     virtual void setFocus(bool);
159     virtual void frameRectsChanged();
160     virtual void setParent(WebCore::ScrollView*);
161     virtual void handleEvent(WebCore::Event*);
162     virtual void notifyWidget(WebCore::WidgetNotification);
163     virtual void show();
164     virtual void hide();
165     virtual bool transformsAffectFrameRect();
166     virtual void clipRectChanged() OVERRIDE;
167
168     // WebCore::MediaCanStartListener
169     virtual void mediaCanStart();
170
171     // PluginController
172     virtual bool isPluginVisible();
173     virtual void invalidate(const WebCore::IntRect&);
174     virtual String userAgent();
175     virtual void loadURL(uint64_t requestID, const String& method, const String& urlString, const String& target, 
176                          const WebCore::HTTPHeaderMap& headerFields, const Vector<uint8_t>& httpBody, bool allowPopups);
177     virtual void cancelStreamLoad(uint64_t streamID);
178     virtual void cancelManualStreamLoad();
179 #if ENABLE(NETSCAPE_PLUGIN_API)
180     virtual NPObject* windowScriptNPObject();
181     virtual NPObject* pluginElementNPObject();
182     virtual bool evaluate(NPObject*, const String&scriptString, NPVariant* result, bool allowPopups);
183 #endif
184     virtual void setStatusbarText(const String&);
185     virtual bool isAcceleratedCompositingEnabled();
186     virtual void pluginProcessCrashed();
187     virtual void willSendEventToPlugin();
188 #if PLATFORM(MAC)
189     virtual void pluginFocusOrWindowFocusChanged(bool pluginHasFocusAndWindowHasFocus);
190     virtual void setComplexTextInputState(PluginComplexTextInputState);
191     virtual mach_port_t compositingRenderServerPort();
192 #endif
193     virtual float contentsScaleFactor();
194     virtual String proxiesForURL(const String&);
195     virtual String cookiesForURL(const String&);
196     virtual void setCookiesForURL(const String& urlString, const String& cookieString);
197     virtual bool getAuthenticationInfo(const WebCore::ProtectionSpace&, String& username, String& password);
198     virtual bool isPrivateBrowsingEnabled();
199     virtual bool asynchronousPluginInitializationEnabled() const;
200     virtual bool asynchronousPluginInitializationEnabledForAllPlugins() const;
201     virtual bool artificialPluginInitializationDelayEnabled() const;
202     virtual void protectPluginFromDestruction();
203     virtual void unprotectPluginFromDestruction();
204 #if PLUGIN_ARCHITECTURE(X11)
205     virtual uint64_t createPluginContainer();
206     virtual void windowedPluginGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect, uint64_t windowID);
207 #endif
208
209     virtual void didInitializePlugin();
210     virtual void didFailToInitializePlugin();
211     void destroyPluginAndReset();
212
213     // WebFrame::LoadListener
214     virtual void didFinishLoad(WebFrame*);
215     virtual void didFailLoad(WebFrame*, bool wasCancelled);
216
217     PassOwnPtr<WebEvent> createWebEvent(WebCore::MouseEvent*) const;
218
219     RefPtr<WebCore::HTMLPlugInElement> m_pluginElement;
220     RefPtr<Plugin> m_plugin;
221     WebPage* m_webPage;
222     Plugin::Parameters m_parameters;
223     
224     bool m_isInitialized;
225     bool m_isWaitingForSynchronousInitialization;
226     bool m_isWaitingUntilMediaCanStart;
227     bool m_isBeingDestroyed;
228
229     // Pending URLRequests that the plug-in has made.
230     Deque<RefPtr<URLRequest> > m_pendingURLRequests;
231     WebCore::RunLoop::Timer<PluginView> m_pendingURLRequestsTimer;
232
233     // Pending frame loads that the plug-in has made.
234     typedef HashMap<RefPtr<WebFrame>, RefPtr<URLRequest> > FrameLoadMap;
235     FrameLoadMap m_pendingFrameLoads;
236
237     // Streams that the plug-in has requested to load. 
238     HashMap<uint64_t, RefPtr<Stream> > m_streams;
239
240 #if ENABLE(NETSCAPE_PLUGIN_API)
241     // A map of all related NPObjects for this plug-in view.
242     NPRuntimeObjectMap m_npRuntimeObjectMap;
243 #endif
244
245     // The manual stream state. This is used so we can deliver a manual stream to a plug-in
246     // when it is initialized.
247     enum ManualStreamState {
248         StreamStateInitial,
249         StreamStateHasReceivedResponse,
250         StreamStateFinished,
251         StreamStateFailed
252     };
253     ManualStreamState m_manualStreamState;
254
255     WebCore::ResourceResponse m_manualStreamResponse;
256     WebCore::ResourceError m_manualStreamError;
257     RefPtr<WebCore::SharedBuffer> m_manualStreamData;
258     
259     // This snapshot is used to avoid side effects should the plugin run JS during painting.
260     RefPtr<ShareableBitmap> m_transientPaintingSnapshot;
261     // This timer is used when plugin snapshotting is enabled, to capture a plugin placeholder.
262     WebCore::DeferrableOneShotTimer<PluginView> m_pluginSnapshotTimer;
263     unsigned m_countSnapshotRetries;
264     bool m_didReceiveUserInteraction;
265
266     double m_pageScaleFactor;
267 };
268
269 } // namespace WebKit
270
271 #endif // PluginView_h