02fa1ab57719b9887d27a6bd2354b541ee78411e
[WebKit-https.git] / Source / WebKit2 / WebProcess / Plugins / PluginProxy.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 PluginProxy_h
27 #define PluginProxy_h
28
29 #if ENABLE(PLUGIN_PROCESS)
30
31 #include "Connection.h"
32 #include "Plugin.h"
33 #include <WebCore/AffineTransform.h>
34 #include <WebCore/IntRect.h>
35 #include <WebCore/SecurityOrigin.h>
36
37 #if PLATFORM(MAC)
38 #include <wtf/RetainPtr.h>
39 OBJC_CLASS CALayer;
40 #endif
41
42 namespace WebCore {
43     class HTTPHeaderMap;
44     class ProtectionSpace;
45 }
46
47 namespace WebKit {
48
49 class ShareableBitmap;
50 class NPVariantData;
51 class PluginProcessConnection;
52
53 struct PluginCreationParameters;
54
55 class PluginProxy : public Plugin {
56 public:
57     static PassRefPtr<PluginProxy> create(const String& pluginPath);
58     ~PluginProxy();
59
60     uint64_t pluginInstanceID() const { return m_pluginInstanceID; }
61     void pluginProcessCrashed();
62
63     void didReceivePluginProxyMessage(CoreIPC::Connection*, CoreIPC::MessageID messageID, CoreIPC::ArgumentDecoder* arguments);
64     void didReceiveSyncPluginProxyMessage(CoreIPC::Connection*, CoreIPC::MessageID, CoreIPC::ArgumentDecoder*, OwnPtr<CoreIPC::ArgumentEncoder>&);
65
66     bool isBeingAsynchronouslyInitialized() const { return m_waitingOnAsynchronousInitialization; }
67
68 private:
69     explicit PluginProxy(const String& pluginPath);
70
71     // Plugin
72     virtual bool initialize(const Parameters&);
73     bool initializeSynchronously();
74
75     virtual void destroy();
76     virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect& dirtyRect);
77     virtual PassRefPtr<ShareableBitmap> snapshot();
78 #if PLATFORM(MAC)
79     virtual PlatformLayer* pluginLayer();
80 #endif
81     virtual bool isTransparent();
82     virtual bool wantsWheelEvents() OVERRIDE;
83     virtual void geometryDidChange(const WebCore::IntSize& pluginSize, const WebCore::IntRect& clipRect, const WebCore::AffineTransform& pluginToRootViewTransform);
84     virtual void visibilityDidChange();
85     virtual void frameDidFinishLoading(uint64_t requestID);
86     virtual void frameDidFail(uint64_t requestID, bool wasCancelled);
87     virtual void didEvaluateJavaScript(uint64_t requestID, const String& result);
88     virtual void streamDidReceiveResponse(uint64_t streamID, const WebCore::KURL& responseURL, uint32_t streamLength, uint32_t lastModifiedTime, const String& mimeType, const String& headers, const String& suggestedFileName);
89     virtual void streamDidReceiveData(uint64_t streamID, const char* bytes, int length);
90     virtual void streamDidFinishLoading(uint64_t streamID);
91     virtual void streamDidFail(uint64_t streamID, bool wasCancelled);
92     virtual void manualStreamDidReceiveResponse(const WebCore::KURL& responseURL, uint32_t streamLength, uint32_t lastModifiedTime, const WTF::String& mimeType, const WTF::String& headers, const String& suggestedFileName);
93     virtual void manualStreamDidReceiveData(const char* bytes, int length);
94     virtual void manualStreamDidFinishLoading();
95     virtual void manualStreamDidFail(bool wasCancelled);
96     
97     virtual bool handleMouseEvent(const WebMouseEvent&);
98     virtual bool handleWheelEvent(const WebWheelEvent&);
99     virtual bool handleMouseEnterEvent(const WebMouseEvent&);
100     virtual bool handleMouseLeaveEvent(const WebMouseEvent&);
101     virtual bool handleContextMenuEvent(const WebMouseEvent&);
102     virtual bool handleKeyboardEvent(const WebKeyboardEvent&);
103     virtual void setFocus(bool);
104     virtual bool handleEditingCommand(const String& commandName, const String& argument) OVERRIDE;
105     virtual bool isEditingCommandEnabled(const String& commandName) OVERRIDE;
106     
107     virtual bool handlesPageScaleFactor();
108     
109     virtual NPObject* pluginScriptableNPObject();
110 #if PLATFORM(MAC)
111     virtual void windowFocusChanged(bool);
112     virtual void windowAndViewFramesChanged(const WebCore::IntRect& windowFrameInScreenCoordinates, const WebCore::IntRect& viewFrameInWindowCoordinates);
113     virtual void windowVisibilityChanged(bool);
114     virtual uint64_t pluginComplexTextInputIdentifier() const;
115     virtual void sendComplexTextInput(const String& textInput);
116     virtual void setLayerHostingMode(LayerHostingMode) OVERRIDE;
117 #endif
118
119     virtual void contentsScaleFactorChanged(float);
120     virtual void storageBlockingStateChanged(bool);
121     virtual void privateBrowsingStateChanged(bool);
122     virtual bool getFormValue(String& formValue);
123     virtual bool handleScroll(WebCore::ScrollDirection, WebCore::ScrollGranularity);
124     virtual WebCore::Scrollbar* horizontalScrollbar();
125     virtual WebCore::Scrollbar* verticalScrollbar();
126
127     float contentsScaleFactor();
128     bool needsBackingStore() const;
129     bool updateBackingStore();
130     uint64_t windowNPObjectID();
131     WebCore::IntRect pluginBounds();
132
133     void geometryDidChange();
134
135     // Message handlers.
136     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);
137     void update(const WebCore::IntRect& paintedRect);
138     void proxiesForURL(const String& urlString, String& proxyString);
139     void cookiesForURL(const String& urlString, String& cookieString);
140     void setCookiesForURL(const String& urlString, const String& cookieString);
141     void getAuthenticationInfo(const WebCore::ProtectionSpace&, bool& returnValue, String& username, String& password);
142     void getPluginElementNPObject(uint64_t& pluginElementNPObjectID);
143     void evaluate(const NPVariantData& npObjectAsVariantData, const String& scriptString, bool allowPopups, bool& returnValue, NPVariantData& resultData);
144     void cancelStreamLoad(uint64_t streamID);
145     void cancelManualStreamLoad();
146     void setStatusbarText(const String& statusbarText);
147 #if PLATFORM(MAC)
148     void pluginFocusOrWindowFocusChanged(bool);
149     void setComplexTextInputState(uint64_t);
150     void setLayerHostingContextID(uint32_t);
151 #endif
152 #if PLUGIN_ARCHITECTURE(X11)
153     void createPluginContainer(uint64_t& windowID);
154     void windowedPluginGeometryDidChange(const WebCore::IntRect& frameRect, const WebCore::IntRect& clipRect, uint64_t windowID);
155 #endif
156
157     bool canInitializeAsynchronously() const;
158
159     void didCreatePlugin(bool wantsWheelEvents, uint32_t remoteLayerClientID);
160     void didFailToCreatePlugin();
161     
162     void didCreatePluginInternal(bool wantsWheelEvents, uint32_t remoteLayerClientID);
163     void didFailToCreatePluginInternal();
164
165     String m_pluginPath;
166
167     RefPtr<PluginProcessConnection> m_connection;
168     uint64_t m_pluginInstanceID;
169
170     WebCore::IntSize m_pluginSize;
171
172     // The clip rect in plug-in coordinates.
173     WebCore::IntRect m_clipRect;
174
175     // A transform that can be used to convert from root view coordinates to plug-in coordinates.
176     WebCore::AffineTransform m_pluginToRootViewTransform;
177
178     // This is the backing store that we paint when we're told to paint.
179     RefPtr<ShareableBitmap> m_backingStore;
180
181     // This is the shared memory backing store that the plug-in paints into. When the plug-in tells us
182     // that it's painted something in it, we'll blit from it to our own backing store.
183     RefPtr<ShareableBitmap> m_pluginBackingStore;
184     
185     // Whether all of the plug-in backing store contains valid data.
186     bool m_pluginBackingStoreContainsValidData;
187
188     bool m_isStarted;
189
190     // Whether we're called invalidate in response to an update call, and are now waiting for a paint call.
191     bool m_waitingForPaintInResponseToUpdate;
192
193     // Whether we should send wheel events to this plug-in or not.
194     bool m_wantsWheelEvents;
195
196     // The client ID for the CA layer in the plug-in process. Will be 0 if the plug-in is not a CA plug-in.
197     uint32_t m_remoteLayerClientID;
198     
199     OwnPtr<PluginCreationParameters> m_pendingPluginCreationParameters;
200     bool m_waitingOnAsynchronousInitialization;
201
202 #if PLATFORM(MAC)
203     RetainPtr<CALayer> m_pluginLayer;
204 #endif
205 };
206
207 } // namespace WebKit
208
209 #endif // ENABLE(PLUGIN_PROCESS)
210
211 #endif // PluginProxy_h