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