975197919d18f2f9b6aa31f710ed0d98051a8f0d
[WebKit-https.git] / Source / WebCore / bindings / v8 / V8Proxy.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  * 
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  * 
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef V8Proxy_h
32 #define V8Proxy_h
33
34 #include "PlatformSupport.h"
35 #include "SharedPersistent.h"
36 #include "StatsCounter.h"
37 #include "V8AbstractEventListener.h"
38 #include "V8DOMWindowShell.h"
39 #include "V8DOMWrapper.h"
40 #include "V8GCController.h"
41 #include "V8Utilities.h"
42 #include "WrapperTypeInfo.h"
43 #include <v8.h>
44 #include <wtf/Forward.h>
45 #include <wtf/PassRefPtr.h> // so generated bindings don't have to
46 #include <wtf/Vector.h>
47 #include <wtf/text/TextPosition.h>
48
49 #if defined(ENABLE_DOM_STATS_COUNTERS) && PLATFORM(CHROMIUM)
50 #define INC_STATS(name) StatsCounter::incrementStatsCounter(name)
51 #else
52 #define INC_STATS(name)
53 #endif
54
55 namespace WebCore {
56
57     class CachedScript;
58     class DOMWindow;
59     class Frame;
60     class Node;
61     class ScriptExecutionContext;
62     class ScriptSourceCode;
63     class SecurityOrigin;
64     class V8BindingPerContextData;
65     class V8EventListener;
66     class V8IsolatedContext;
67     class WorldContextHandle;
68
69     // The following Batch structs and methods are used for setting multiple
70     // properties on an ObjectTemplate, used from the generated bindings
71     // initialization (ConfigureXXXTemplate). This greatly reduces the binary
72     // size by moving from code driven setup to data table driven setup.
73
74     // BatchedAttribute translates into calls to SetAccessor() on either the
75     // instance or the prototype ObjectTemplate, based on |onProto|.
76     struct BatchedAttribute {
77         const char* const name;
78         v8::AccessorGetter getter;
79         v8::AccessorSetter setter;
80         WrapperTypeInfo* data;
81         v8::AccessControl settings;
82         v8::PropertyAttribute attribute;
83         bool onProto;
84     };
85
86     void batchConfigureAttributes(v8::Handle<v8::ObjectTemplate>, v8::Handle<v8::ObjectTemplate>, const BatchedAttribute*, size_t attributeCount);
87
88     template<class ObjectOrTemplate>
89     inline void configureAttribute(v8::Handle<ObjectOrTemplate> instance, v8::Handle<ObjectOrTemplate> proto, const BatchedAttribute& attribute)
90     {
91         (attribute.onProto ? proto : instance)->SetAccessor(v8::String::New(attribute.name),
92             attribute.getter,
93             attribute.setter,
94             v8::External::Wrap(attribute.data),
95             attribute.settings,
96             attribute.attribute);
97     }
98
99     // BatchedConstant translates into calls to Set() for setting up an object's
100     // constants. It sets the constant on both the FunctionTemplate and the
101     // ObjectTemplate. PropertyAttributes is always ReadOnly.
102     struct BatchedConstant {
103         const char* const name;
104         int value;
105     };
106
107     void batchConfigureConstants(v8::Handle<v8::FunctionTemplate>, v8::Handle<v8::ObjectTemplate>, const BatchedConstant*, size_t constantCount);
108
109     struct BatchedCallback {
110         const char* const name;
111         v8::InvocationCallback callback;
112     };
113
114     void batchConfigureCallbacks(v8::Handle<v8::ObjectTemplate>, 
115                                  v8::Handle<v8::Signature>,
116                                  v8::PropertyAttribute,
117                                  const BatchedCallback*, 
118                                  size_t callbackCount);
119
120     const int kMaxRecursionDepth = 22;
121
122     // The list of extensions that are registered for use with V8.
123     typedef WTF::Vector<v8::Extension*> V8Extensions;
124
125     class V8Proxy {
126     public:
127         // The types of javascript errors that can be thrown.
128         enum ErrorType {
129             RangeError,
130             ReferenceError,
131             SyntaxError,
132             TypeError,
133             GeneralError
134         };
135
136         explicit V8Proxy(Frame*);
137
138         ~V8Proxy();
139
140         Frame* frame() { return m_frame; }
141
142         void clearForNavigation();
143         void clearForClose();
144
145         void finishedWithEvent(Event*) { }
146
147         // Evaluate JavaScript in a new isolated world. The script gets its own
148         // global scope, its own prototypes for intrinsic JavaScript objects (String,
149         // Array, and so-on), and its own wrappers for all DOM nodes and DOM
150         // constructors.
151         void evaluateInIsolatedWorld(int worldID, const Vector<ScriptSourceCode>& sources, int extensionGroup, WTF::Vector<v8::Local<v8::Value> >* result);
152
153         void setIsolatedWorldSecurityOrigin(int worldID, PassRefPtr<SecurityOrigin>);
154
155         // Evaluate a script file in the current execution environment.
156         // The caller must hold an execution context.
157         // If cannot evalute the script, it returns an error.
158         v8::Local<v8::Value> evaluate(const ScriptSourceCode&, Node*);
159
160         // Run an already compiled script.
161         v8::Local<v8::Value> runScript(v8::Handle<v8::Script>);
162
163         // Call the function with the given receiver and arguments.
164         v8::Local<v8::Value> callFunction(v8::Handle<v8::Function>, v8::Handle<v8::Object>, int argc, v8::Handle<v8::Value> argv[]);
165
166         // call the function with the given receiver and arguments and report times to DevTools.
167         static v8::Local<v8::Value> instrumentedCallFunction(Frame*, v8::Handle<v8::Function>, v8::Handle<v8::Object> receiver, int argc, v8::Handle<v8::Value> args[]);
168
169         // Call the function as constructor with the given arguments.
170         v8::Local<v8::Value> newInstance(v8::Handle<v8::Function>, int argc, v8::Handle<v8::Value> argv[]);
171
172         // Returns the window object associated with a context.
173         static DOMWindow* retrieveWindow(v8::Handle<v8::Context>);
174
175         // Returns V8Proxy object of the currently executing context.
176         static V8Proxy* retrieve();
177         // Returns V8Proxy object associated with a frame.
178         static V8Proxy* retrieve(Frame*);
179         // Returns V8Proxy object associated with a script execution context.
180         static V8Proxy* retrieve(ScriptExecutionContext*);
181
182         // Returns the frame object of the window object associated with
183         // a context.
184         static Frame* retrieveFrame(v8::Handle<v8::Context>);
185
186         static V8BindingPerContextData* retrievePerContextData(Frame*);
187
188         // The three functions below retrieve WebFrame instances relating the
189         // currently executing JavaScript. Since JavaScript can make function calls
190         // across frames, though, we need to be more precise.
191         //
192         // For example, imagine that a JS function in frame A calls a function in
193         // frame B, which calls native code, which wants to know what the 'active'
194         // frame is.
195         //
196         // The 'entered context' is the context where execution first entered the
197         // script engine; the context that is at the bottom of the JS function stack.
198         // RetrieveFrameForEnteredContext() would return Frame A in our example.
199         // This frame is often referred to as the "dynamic global object."
200         //
201         // The 'current context' is the context the JS engine is currently inside of;
202         // the context that is at the top of the JS function stack.
203         // RetrieveFrameForCurrentContext() would return Frame B in our example.
204         // This frame is often referred to as the "lexical global object."
205         //
206         // Finally, the 'calling context' is the context one below the current
207         // context on the JS function stack. For example, if function f calls
208         // function g, then the calling context will be the context associated with
209         // f. This context is commonly used by DOM security checks because they want
210         // to know who called them.
211         //
212         // If you are unsure which of these functions to use, ask abarth.
213         //
214         // NOTE: These cannot be declared as inline function, because VS complains at
215         // linking time.
216         static Frame* retrieveFrameForEnteredContext();
217         static Frame* retrieveFrameForCurrentContext();
218         static DOMWindow* retrieveWindowForCallingContext();
219         static Frame* retrieveFrameForCallingContext();
220
221         // Returns V8 Context of a frame. If none exists, creates
222         // a new context. It is potentially slow and consumes memory.
223         static v8::Local<v8::Context> context(Frame*);
224         static v8::Local<v8::Context> mainWorldContext(Frame*);
225         static v8::Local<v8::Context> currentContext();
226
227         // If the current context causes out of memory, JavaScript setting
228         // is disabled and it returns true.
229         static bool handleOutOfMemory();
230
231         static v8::Handle<v8::Value> checkNewLegal(const v8::Arguments&);
232
233         static v8::Handle<v8::Script> compileScript(v8::Handle<v8::String> code, const String& fileName, const TextPosition& scriptStartPosition, v8::ScriptData* = 0);
234
235         // If the exception code is different from zero, a DOM exception is
236         // schedule to be thrown.
237         static void setDOMException(int exceptionCode, v8::Isolate*);
238
239         // Schedule an error object to be thrown.
240         static v8::Handle<v8::Value> throwError(ErrorType, const char* message, v8::Isolate* = 0);
241
242         // Helpers for throwing syntax and type errors with predefined messages.
243         static v8::Handle<v8::Value> throwTypeError(const char* = 0);
244         static v8::Handle<v8::Value> throwNotEnoughArgumentsError(v8::Isolate*);
245
246         v8::Local<v8::Context> context();
247         v8::Local<v8::Context> mainWorldContext();
248         v8::Local<v8::Context> isolatedWorldContext(int worldId);
249         bool matchesCurrentContext();
250
251         // FIXME: This should eventually take DOMWrapperWorld argument!
252         V8DOMWindowShell* windowShell() const { return m_windowShell.get(); }
253
254         bool setContextDebugId(int id);
255         static int contextDebugId(v8::Handle<v8::Context>);
256         void collectIsolatedContexts(Vector<std::pair<ScriptState*, SecurityOrigin*> >&);
257
258         // Registers a v8 extension to be available on webpages. Will only
259         // affect v8 contexts initialized after this call. Takes ownership of
260         // the v8::Extension object passed.
261         static void registerExtension(v8::Extension*);
262
263         static void registerExtensionWithV8(v8::Extension*);
264         static bool registeredExtensionWithV8(v8::Extension*);
265
266         static const V8Extensions& extensions();
267
268         // Report an unsafe attempt to access the given frame on the console.
269         static void reportUnsafeAccessTo(Frame* target);
270
271     private:
272         void resetIsolatedWorlds();
273
274         PassOwnPtr<v8::ScriptData> precompileScript(v8::Handle<v8::String>, CachedScript*);
275
276         static const char* rangeExceptionName(int exceptionCode);
277         static const char* eventExceptionName(int exceptionCode);
278         static const char* xmlHttpRequestExceptionName(int exceptionCode);
279         static const char* domExceptionName(int exceptionCode);
280         static const char* xpathExceptionName(int exceptionCode);
281
282 #if ENABLE(SVG)
283         static const char* svgExceptionName(int exceptionCode);
284 #endif
285
286 #if ENABLE(SQL_DATABASE)
287         static const char* sqlExceptionName(int exceptionCode);
288 #endif
289
290         Frame* m_frame;
291
292         // For the moment, we have one of these.  Soon we will have one per DOMWrapperWorld.
293         RefPtr<V8DOMWindowShell> m_windowShell;
294
295         // All of the extensions registered with the context.
296         static V8Extensions m_extensions;
297
298         // The isolated worlds we are tracking for this frame. We hold them alive
299         // here so that they can be used again by future calls to
300         // evaluateInIsolatedWorld().
301         //
302         // Note: although the pointer is raw, the instance is kept alive by a strong
303         // reference to the v8 context it contains, which is not made weak until we
304         // call world->destroy().
305         //
306         // FIXME: We want to eventually be holding window shells instead of the
307         //        IsolatedContext directly.
308         typedef HashMap<int, V8IsolatedContext*> IsolatedWorldMap;
309         IsolatedWorldMap m_isolatedWorlds;
310         
311         typedef HashMap<int, RefPtr<SecurityOrigin> > IsolatedWorldSecurityOriginMap;
312         IsolatedWorldSecurityOriginMap m_isolatedWorldSecurityOrigins;
313     };
314
315     v8::Local<v8::Context> toV8Context(ScriptExecutionContext*, const WorldContextHandle& worldContext);
316
317     inline v8::Handle<v8::Primitive> throwError(ExceptionCode ec, v8::Isolate* isolate = 0)
318     {
319         if (!v8::V8::IsExecutionTerminating())
320             V8Proxy::setDOMException(ec, isolate);
321         return v8::Undefined();
322     }
323
324     inline v8::Handle<v8::Primitive> throwError(v8::Local<v8::Value> exception, v8::Isolate* isolate = 0)
325     {
326         if (!v8::V8::IsExecutionTerminating())
327             v8::ThrowException(exception);
328         return v8::Undefined();
329     }
330
331     enum IndependentMode {
332         MarkIndependent,
333         DoNotMarkIndependent
334     };
335 }
336
337 #endif // V8Proxy_h