38843004a8006872b1d925880685c7bd5b3b89b8
[WebKit-https.git] / WebKitTools / DumpRenderTree / TestNetscapePlugIn.subproj / PluginObject.c
1 /*
2  IMPORTANT:  This Apple software is supplied to you by Apple Computer, Inc. ("Apple") in
3  consideration of your agreement to the following terms, and your use, installation, 
4  modification or redistribution of this Apple software constitutes acceptance of these 
5  terms.  If you do not agree with these terms, please do not use, install, modify or 
6  redistribute this Apple software.
7  
8  In consideration of your agreement to abide by the following terms, and subject to these 
9  terms, Apple grants you a personal, non-exclusive license, under Appleƕs copyrights in 
10  this original Apple software (the "Apple Software"), to use, reproduce, modify and 
11  redistribute the Apple Software, with or without modifications, in source and/or binary 
12  forms; provided that if you redistribute the Apple Software in its entirety and without 
13  modifications, you must retain this notice and the following text and disclaimers in all 
14  such redistributions of the Apple Software.  Neither the name, trademarks, service marks 
15  or logos of Apple Computer, Inc. may be used to endorse or promote products derived from 
16  the Apple Software without specific prior written permission from Apple. Except as expressly
17  stated in this notice, no other rights or licenses, express or implied, are granted by Apple
18  herein, including but not limited to any patent rights that may be infringed by your 
19  derivative works or by other works in which the Apple Software may be incorporated.
20  
21  The Apple Software is provided by Apple on an "AS IS" basis.  APPLE MAKES NO WARRANTIES, 
22  EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, 
23  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS 
24  USE AND OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
25  
26  IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL 
27  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
28  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, 
29  REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED AND 
30  WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR 
31  OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #import "PluginObject.h"
35
36 static void pluginInvalidate(NPObject *obj);
37 static bool pluginHasProperty(NPObject *obj, NPIdentifier name);
38 static bool pluginHasMethod(NPObject *obj, NPIdentifier name);
39 static bool pluginGetProperty(NPObject *obj, NPIdentifier name, NPVariant *variant);
40 static bool pluginSetProperty(NPObject *obj, NPIdentifier name, const NPVariant *variant);
41 static bool pluginInvoke(NPObject *obj, NPIdentifier name, const NPVariant *args, uint32_t argCount, NPVariant *result);
42 static bool pluginInvokeDefault(NPObject *obj, const NPVariant *args, uint32_t argCount, NPVariant *result);
43 static NPObject *pluginAllocate(NPP npp, NPClass *theClass);
44 static void pluginDeallocate(NPObject *obj);
45
46 NPNetscapeFuncs *browser;
47
48 static NPClass pluginClass = { 
49     NP_CLASS_STRUCT_VERSION,
50     pluginAllocate, 
51     pluginDeallocate, 
52     pluginInvalidate,
53     pluginHasMethod,
54     pluginInvoke,
55     pluginInvokeDefault,
56     pluginHasProperty,
57     pluginGetProperty,
58     pluginSetProperty,
59 };
60  
61 NPClass *getPluginClass(void)
62 {
63     return &pluginClass;
64 }
65
66 static bool identifiersInitialized = false;
67
68 #define ID_PROPERTY_PROPERTY        0
69 #define ID_PROPERTY_EVENT_LOGGING   1
70 #define NUM_PROPERTY_IDENTIFIERS    2
71
72 static NPIdentifier pluginPropertyIdentifiers[NUM_PROPERTY_IDENTIFIERS];
73 static const NPUTF8 *pluginPropertyIdentifierNames[NUM_PROPERTY_IDENTIFIERS] = {
74     "property",
75     "eventLoggingEnabled"
76 };
77
78 #define ID_TEST_CALLBACK_METHOD     0
79 #define ID_TEST_GETURL              1
80 #define ID_REMOVE_DEFAULT_METHOD    2
81 #define ID_TEST_DOM_ACCESS          3
82 #define ID_TEST_GET_URL_NOTIFY      4
83 #define ID_TEST_INVOKE_DEFAULT      5
84 #define NUM_METHOD_IDENTIFIERS      6
85
86 static NPIdentifier pluginMethodIdentifiers[NUM_METHOD_IDENTIFIERS];
87 static const NPUTF8 *pluginMethodIdentifierNames[NUM_METHOD_IDENTIFIERS] = {
88     "testCallback",
89     "getURL",
90     "removeDefaultMethod",
91     "testDOMAccess",
92     "getURLNotify",
93     "testInvokeDefault"
94 };
95
96 static NPUTF8* createCStringFromNPVariant(const NPVariant *variant)
97 {
98     size_t length = NPVARIANT_TO_STRING(*variant).UTF8Length;
99     NPUTF8* result = malloc(length + 1);
100     memcpy(result, NPVARIANT_TO_STRING(*variant).UTF8Characters, length);
101     result[length] = '\0';
102     return result;
103 }
104
105 static void initializeIdentifiers(void)
106 {
107     browser->getstringidentifiers(pluginPropertyIdentifierNames, NUM_PROPERTY_IDENTIFIERS, pluginPropertyIdentifiers);
108     browser->getstringidentifiers(pluginMethodIdentifierNames, NUM_METHOD_IDENTIFIERS, pluginMethodIdentifiers);
109 }
110
111 static bool pluginHasProperty(NPObject *obj, NPIdentifier name)
112 {
113     for (int i = 0; i < NUM_PROPERTY_IDENTIFIERS; i++)
114         if (name == pluginPropertyIdentifiers[i])
115             return true;
116     return false;
117 }
118
119 static bool pluginHasMethod(NPObject *obj, NPIdentifier name)
120 {
121     for (int i = 0; i < NUM_METHOD_IDENTIFIERS; i++)
122         if (name == pluginMethodIdentifiers[i])
123             return true;
124     return false;
125 }
126
127 static bool pluginGetProperty(NPObject *obj, NPIdentifier name, NPVariant *variant)
128 {
129     if (name == pluginPropertyIdentifiers[ID_PROPERTY_PROPERTY]) {
130         STRINGZ_TO_NPVARIANT("property", *variant);
131         return true;
132     } else if (name == pluginPropertyIdentifiers[ID_PROPERTY_EVENT_LOGGING]) {
133         BOOLEAN_TO_NPVARIANT(((PluginObject *)obj)->eventLogging, *variant);
134         return true;
135     }
136     return false;
137 }
138
139 static bool pluginSetProperty(NPObject *obj, NPIdentifier name, const NPVariant *variant)
140 {
141     if (name == pluginPropertyIdentifiers[ID_PROPERTY_EVENT_LOGGING]) {
142         ((PluginObject *)obj)->eventLogging = NPVARIANT_TO_BOOLEAN(*variant);
143         return true;
144     }
145     return false;
146 }
147
148 static void testDOMAccess(PluginObject *obj)
149 {
150     // Get plug-in's DOM element
151     NPObject *elementObject;
152     if (browser->getvalue(obj->npp, NPNVPluginElementNPObject, &elementObject) == NPERR_NO_ERROR) {
153         // Get style
154         NPVariant styleVariant;
155         NPIdentifier styleIdentifier = browser->getstringidentifier("style");
156         if (browser->getproperty(obj->npp, elementObject, styleIdentifier, &styleVariant) && NPVARIANT_IS_OBJECT(styleVariant)) {
157             // Set style.border
158             NPIdentifier borderIdentifier = browser->getstringidentifier("border");
159             NPVariant borderVariant;
160             STRINGZ_TO_NPVARIANT("3px solid red", borderVariant);
161             browser->setproperty(obj->npp, NPVARIANT_TO_OBJECT(styleVariant), borderIdentifier, &borderVariant);
162             browser->releasevariantvalue(&styleVariant);
163         }
164         
165         browser->releaseobject(elementObject);
166     }
167 }
168
169 static bool pluginInvoke(NPObject *header, NPIdentifier name, const NPVariant *args, uint32_t argCount, NPVariant *result)
170 {
171     PluginObject *obj = (PluginObject *)header;
172     if (name == pluginMethodIdentifiers[ID_TEST_CALLBACK_METHOD]) {
173         // call whatever method name we're given
174         if (argCount > 0 && NPVARIANT_IS_STRING(args[0])) {
175             NPObject *windowScriptObject;
176             browser->getvalue(obj->npp, NPPVpluginScriptableNPObject, &windowScriptObject);
177
178             NPUTF8* callbackString = createCStringFromNPVariant(&args[0]);
179             NPIdentifier callbackIdentifier = browser->getstringidentifier(callbackString);
180             free(callbackString);
181
182             NPVariant browserResult;
183             browser->invoke(obj->npp, windowScriptObject, callbackIdentifier, 0, 0, &browserResult);
184             browser->releasevariantvalue(&browserResult);
185
186             VOID_TO_NPVARIANT(*result);
187             return true;
188         }
189     } else if (name == pluginMethodIdentifiers[ID_TEST_GETURL]) {
190         if (argCount == 2 && NPVARIANT_IS_STRING(args[0]) && NPVARIANT_IS_STRING(args[1])) {
191             NPUTF8* urlString = createCStringFromNPVariant(&args[0]);
192             NPUTF8* targetString = createCStringFromNPVariant(&args[1]);
193             browser->geturl(obj->npp, urlString, targetString);
194             free(urlString);
195             free(targetString);
196
197             VOID_TO_NPVARIANT(*result);
198             return true;
199         } else if (argCount == 1 && NPVARIANT_IS_STRING(args[0])) {
200             NPUTF8* urlString = createCStringFromNPVariant(&args[0]);
201             browser->geturl(obj->npp, urlString, 0);
202             free(urlString);
203
204             VOID_TO_NPVARIANT(*result);
205             return true;
206         }
207     } else if (name == pluginMethodIdentifiers[ID_REMOVE_DEFAULT_METHOD]) {
208         pluginClass.invokeDefault = 0;
209         VOID_TO_NPVARIANT(*result);
210         return true;
211     } else if (name == pluginMethodIdentifiers[ID_TEST_DOM_ACCESS]) {
212         testDOMAccess(obj);
213         VOID_TO_NPVARIANT(*result);
214         return true;
215     } else if (name == pluginMethodIdentifiers[ID_TEST_GET_URL_NOTIFY]) {
216         if (argCount == 3 && NPVARIANT_IS_STRING(args[0]) && NPVARIANT_IS_STRING(args[1]) && NPVARIANT_IS_STRING(args[2])) {
217             NPUTF8* urlString = createCStringFromNPVariant(&args[0]);
218             NPUTF8* targetString = createCStringFromNPVariant(&args[1]);            
219             NPUTF8* callbackString = createCStringFromNPVariant(&args[2]);
220             
221             NPIdentifier callbackIdentifier = browser->getstringidentifier(callbackString);
222             browser->geturlnotify(obj->npp, urlString, targetString, callbackIdentifier);
223
224             free(urlString);
225             free(targetString);
226             free(callbackString);
227             
228             VOID_TO_NPVARIANT(*result);
229             return true;
230         }
231     } else if (name == pluginMethodIdentifiers[ID_TEST_INVOKE_DEFAULT] && NPVARIANT_IS_OBJECT(args[0])) {
232         NPObject *callback = NPVARIANT_TO_OBJECT(args[0]);
233         
234         NPVariant args[1];
235         NPVariant browserResult;
236         
237         STRINGZ_TO_NPVARIANT("test", args[0]);
238         bool retval = browser->invokeDefault(obj->npp, callback, args, 1, &browserResult);
239         
240         if (retval)
241             browser->releasevariantvalue(&browserResult);
242         
243         BOOLEAN_TO_NPVARIANT(retval, *result);
244         return true;        
245     }
246
247     return false;
248 }
249
250 static bool pluginInvokeDefault(NPObject *obj, const NPVariant *args, uint32_t argCount, NPVariant *result)
251 {
252     INT32_TO_NPVARIANT(1, *result);
253     return true;
254 }
255
256 static void pluginInvalidate(NPObject *obj)
257 {
258 }
259
260 static NPObject *pluginAllocate(NPP npp, NPClass *theClass)
261 {
262     PluginObject *newInstance = malloc(sizeof(PluginObject));
263     
264     if (!identifiersInitialized) {
265         identifiersInitialized = true;
266         initializeIdentifiers();
267     }
268
269     newInstance->npp = npp;
270     
271     newInstance->eventLogging = FALSE;
272     
273     return (NPObject *)newInstance;
274 }
275
276 static void pluginDeallocate(NPObject *obj) 
277 {
278     free(obj);
279 }
280
281 void handleCallback(PluginObject* object, const char *url, NPReason reason, void *notifyData)
282 {
283     assert(object);
284     
285     NPVariant args[1];
286     
287     NPObject *windowScriptObject;
288     browser->getvalue(object->npp, NPPVpluginScriptableNPObject, &windowScriptObject);
289     
290     NPIdentifier callbackIdentifier = notifyData;
291
292     INT32_TO_NPVARIANT(reason, args[0]);
293
294     NPVariant browserResult;
295     browser->invoke(object->npp, windowScriptObject, callbackIdentifier, args, 1, &browserResult);
296     browser->releasevariantvalue(&browserResult);
297 }