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