cd9e35b9542eacdb0fb0b32f12cc880b976b0c99
[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/Image.h>
34 #include <WebCore/MediaCanStartListener.h>
35 #include <WebCore/PluginViewBase.h>
36 #include <WebCore/ResourceError.h>
37 #include <WebCore/ResourceResponse.h>
38 #include <WebCore/RunLoop.h>
39 #include <WebCore/Timer.h>
40 #include <wtf/Deque.h>
41
42 // FIXME: Eventually this should move to WebCore.
43
44 namespace WebCore {
45 class Frame;
46 class HTMLPlugInElement;
47 class MouseEvent;
48 class RenderBoxModelObject;
49 }
50
51 namespace WebKit {
52
53 class WebEvent;
54
55 class PluginView : public WebCore::PluginViewBase, public PluginController, private WebCore::MediaCanStartListener, private WebFrame::LoadListener {
56 public:
57     static PassRefPtr<PluginView> create(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters&);
58
59     void recreateAndInitialize(PassRefPtr<Plugin>);
60
61     WebCore::Frame* frame() const;
62
63     bool isBeingDestroyed() const { return m_isBeingDestroyed; }
64
65     void manualLoadDidReceiveResponse(const WebCore::ResourceResponse&);
66     void manualLoadDidReceiveData(const char* bytes, int length);
67     void manualLoadDidFinishLoading();
68     void manualLoadDidFail(const WebCore::ResourceError&);
69
70 #if PLATFORM(MAC)
71     void setWindowIsVisible(bool);
72     void setWindowIsFocused(bool);
73     void setDeviceScaleFactor(float);
74     void windowAndViewFramesChanged(const WebCore::IntRect& windowFrameInScreenCoordinates, const WebCore::IntRect& viewFrameInWindowCoordinates);
75     bool sendComplexTextInput(uint64_t pluginComplexTextInputIdentifier, const String& textInput);
76     void setLayerHostingMode(LayerHostingMode);
77     RetainPtr<PDFDocument> pdfDocumentForPrinting() const { return m_plugin->pdfDocumentForPrinting(); }
78 #endif
79
80     WebCore::HTMLPlugInElement* pluginElement() const { return m_pluginElement.get(); }
81     const Plugin::Parameters& initialParameters() const { return m_parameters; }
82
83     // FIXME: Remove this; nobody should have to know about the plug-in view's renderer except the plug-in view itself.
84     WebCore::RenderBoxModelObject* renderer() const;
85     
86     void setPageScaleFactor(double scaleFactor, WebCore::IntPoint origin);
87     double pageScaleFactor();
88     bool handlesPageScaleFactor() { return m_plugin->handlesPageScaleFactor(); }
89
90     void pageScaleFactorDidChange();
91     void webPageDestroyed();
92
93     virtual bool handleEditingCommand(const String& commandName, const String& argument);
94     virtual bool isEditingCommandEnabled(const String& commandName);
95
96     bool shouldAllowScripting();
97
98 private:
99     PluginView(PassRefPtr<WebCore::HTMLPlugInElement>, PassRefPtr<Plugin>, const Plugin::Parameters& parameters);
100     virtual ~PluginView();
101
102     void initializePlugin();
103
104     void viewGeometryDidChange();
105     void viewVisibilityDidChange();
106     WebCore::IntRect clipRectInWindowCoordinates() const;
107     void focusPluginElement();
108     
109     void pendingURLRequestsTimerFired();
110     class URLRequest;
111     void performURLRequest(URLRequest*);
112
113     // Perform a URL request where the frame target is not null.
114     void performFrameLoadURLRequest(URLRequest*);
115
116     // Perform a URL request where the URL protocol is "javascript:".
117     void performJavaScriptURLRequest(URLRequest*);
118
119     class Stream;
120     void addStream(Stream*);
121     void removeStream(Stream*);
122     void cancelAllStreams();
123
124     void redeliverManualStream();
125
126     void pluginSnapshotTimerFired(WebCore::DeferrableOneShotTimer<PluginView>*);
127
128     // WebCore::PluginViewBase
129 #if PLATFORM(MAC)
130     virtual PlatformLayer* platformLayer() const;
131 #endif
132     virtual JSC::JSObject* scriptObject(JSC::JSGlobalObject*);
133     virtual void storageBlockingStateChanged();
134     virtual void privateBrowsingStateChanged(bool);
135     virtual bool getFormValue(String&);
136     virtual bool scroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
137     virtual WebCore::Scrollbar* horizontalScrollbar();
138     virtual WebCore::Scrollbar* verticalScrollbar();
139     virtual bool wantsWheelEvents();
140
141     // WebCore::Widget
142     virtual void setFrameRect(const WebCore::IntRect&);
143     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect&);
144     virtual void invalidateRect(const WebCore::IntRect&);
145     virtual void setFocus(bool);
146     virtual void frameRectsChanged();
147     virtual void setParent(WebCore::ScrollView*);
148     virtual void handleEvent(WebCore::Event*);
149     virtual void notifyWidget(WebCore::WidgetNotification);
150     virtual void show();
151     virtual void hide();
152     virtual bool transformsAffectFrameRect();
153
154     // WebCore::MediaCanStartListener
155     virtual void mediaCanStart();
156
157     // PluginController
158     virtual bool isPluginVisible();
159     virtual void invalidate(const WebCore::IntRect&);
160     virtual String userAgent();
161     virtual void loadURL(uint64_t requestID, const String& method, const String& urlString, const String& target, 
162                          const WebCore::HTTPHeaderMap& headerFields, const Vector<uint8_t>& httpBody, bool allowPopups);
163     virtual void cancelStreamLoad(uint64_t streamID);
164     virtual void cancelManualStreamLoad();
165 #if ENABLE(NETSCAPE_PLUGIN_API)
166     virtual NPObject* windowScriptNPObject();
167     virtual NPObject* pluginElementNPObject();
168     virtual bool evaluate(NPObject*, const String&scriptString, NPVariant* result, bool allowPopups);
169 #endif
170     virtual void setStatusbarText(const String&);
171     virtual bool isAcceleratedCompositingEnabled();
172     virtual void pluginProcessCrashed();
173     virtual void willSendEventToPlugin();
174 #if PLATFORM(WIN)
175     virtual HWND nativeParentWindow();
176     virtual void scheduleWindowedPluginGeometryUpdate(const WindowGeometry&);
177 #endif
178 #if PLATFORM(MAC)
179     virtual void pluginFocusOrWindowFocusChanged(bool pluginHasFocusAndWindowHasFocus);
180     virtual void setComplexTextInputState(PluginComplexTextInputState);
181     virtual mach_port_t compositingRenderServerPort();
182 #endif
183     virtual float contentsScaleFactor();
184     virtual String proxiesForURL(const String&);
185     virtual String cookiesForURL(const String&);
186     virtual void setCookiesForURL(const String& urlString, const String& cookieString);
187     virtual bool getAuthenticationInfo(const WebCore::ProtectionSpace&, String& username, String& password);
188     virtual bool isPrivateBrowsingEnabled();
189     virtual bool asynchronousPluginInitializationEnabled() const;
190     virtual bool asynchronousPluginInitializationEnabledForAllPlugins() const;
191     virtual bool artificialPluginInitializationDelayEnabled() const;
192     virtual void protectPluginFromDestruction();
193     virtual void unprotectPluginFromDestruction();
194 #if PLUGIN_ARCHITECTURE(X11)
195     virtual uint64_t createPluginContainer();
196     virtual void windowedPluginGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect, uint64_t windowID);
197 #endif
198
199     virtual void didInitializePlugin();
200     virtual void didFailToInitializePlugin();
201     void destroyPluginAndReset();
202
203     // WebFrame::LoadListener
204     virtual void didFinishLoad(WebFrame*);
205     virtual void didFailLoad(WebFrame*, bool wasCancelled);
206
207     PassOwnPtr<WebEvent> createWebEvent(WebCore::MouseEvent*) const;
208
209     RefPtr<WebCore::HTMLPlugInElement> m_pluginElement;
210     RefPtr<Plugin> m_plugin;
211     WebPage* m_webPage;
212     Plugin::Parameters m_parameters;
213     
214     bool m_isInitialized;
215     bool m_isWaitingForSynchronousInitialization;
216     bool m_isWaitingUntilMediaCanStart;
217     bool m_isBeingDestroyed;
218
219     // Pending URLRequests that the plug-in has made.
220     Deque<RefPtr<URLRequest> > m_pendingURLRequests;
221     WebCore::RunLoop::Timer<PluginView> m_pendingURLRequestsTimer;
222
223     // Pending frame loads that the plug-in has made.
224     typedef HashMap<RefPtr<WebFrame>, RefPtr<URLRequest> > FrameLoadMap;
225     FrameLoadMap m_pendingFrameLoads;
226
227     // Streams that the plug-in has requested to load. 
228     HashMap<uint64_t, RefPtr<Stream> > m_streams;
229
230 #if ENABLE(NETSCAPE_PLUGIN_API)
231     // A map of all related NPObjects for this plug-in view.
232     NPRuntimeObjectMap m_npRuntimeObjectMap;
233 #endif
234
235     // The manual stream state. This is used so we can deliver a manual stream to a plug-in
236     // when it is initialized.
237     enum ManualStreamState {
238         StreamStateInitial,
239         StreamStateHasReceivedResponse,
240         StreamStateFinished,
241         StreamStateFailed
242     };
243     ManualStreamState m_manualStreamState;
244
245     WebCore::ResourceResponse m_manualStreamResponse;
246     WebCore::ResourceError m_manualStreamError;
247     RefPtr<WebCore::SharedBuffer> m_manualStreamData;
248     
249     // This snapshot is used to avoid side effects should the plugin run JS during painting.
250     RefPtr<ShareableBitmap> m_transientPaintingSnapshot;
251     // This timer is used when plugin snapshotting is enabled, to capture a plugin placeholder.
252     WebCore::DeferrableOneShotTimer<PluginView> m_pluginSnapshotTimer;
253
254     double m_pageScaleFactor;
255 };
256
257 } // namespace WebKit
258
259 #endif // PluginView_h