REGRESSION(r59977): platform/mac/fast/AppleScript/001.html failure
[WebKit.git] / WebCore / bindings / js / ScriptController.h
1 /*
2  *  Copyright (C) 1999 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2008 Apple Inc. All rights reserved.
5  *  Copyright (C) 2008 Eric Seidel <eric@webkit.org>
6  *
7  *  This library is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU Lesser General Public
9  *  License as published by the Free Software Foundation; either
10  *  version 2 of the License, or (at your option) any later version.
11  *
12  *  This library is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  Lesser General Public License for more details.
16  *
17  *  You should have received a copy of the GNU Lesser General Public
18  *  License along with this library; if not, write to the Free Software
19  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 #ifndef ScriptController_h
23 #define ScriptController_h
24
25 #include "JSDOMWindowShell.h"
26 #include "ScriptInstance.h"
27 #include <runtime/Protect.h>
28 #include <wtf/RefPtr.h>
29
30 #if PLATFORM(MAC)
31 #include <wtf/RetainPtr.h>
32
33 #ifdef __OBJC__
34 @class WebScriptObject;
35 #else
36 class WebScriptObject;
37 #endif
38 #endif
39
40 struct NPObject;
41
42 namespace JSC {
43     class JSGlobalObject;
44
45     namespace Bindings {
46         class RootObject;
47     }
48 }
49
50 namespace WebCore {
51
52 class Event;
53 class EventListener;
54 class HTMLPlugInElement;
55 class Frame;
56 class Node;
57 class ScriptSourceCode;
58 class ScriptValue;
59 class String;
60 class Widget;
61 class XSSAuditor;
62
63 typedef HashMap<void*, RefPtr<JSC::Bindings::RootObject> > RootObjectMap;
64
65 enum ReasonForCallingCanExecuteScripts {
66     AboutToExecuteScript,
67     NotAboutToExecuteScript
68 };
69
70 // Whether to call the XSSAuditor to audit a script before passing it to the JavaScript engine.
71 enum ShouldAllowXSS {
72     AllowXSS,
73     DoNotAllowXSS
74 };
75
76 class ScriptController {
77     friend class ScriptCachedFrameData;
78     typedef WTF::HashMap< RefPtr<DOMWrapperWorld>, JSC::ProtectedPtr<JSDOMWindowShell> > ShellMap;
79
80 public:
81     ScriptController(Frame*);
82     ~ScriptController();
83
84     static PassRefPtr<DOMWrapperWorld> createWorld();
85
86     JSDOMWindowShell* createWindowShell(DOMWrapperWorld*);
87     void destroyWindowShell(DOMWrapperWorld*);
88
89     JSDOMWindowShell* windowShell(DOMWrapperWorld* world)
90     {
91         ShellMap::iterator iter = m_windowShells.find(world);
92         return (iter != m_windowShells.end()) ? iter->second.get() : initScript(world);
93     }
94     JSDOMWindowShell* existingWindowShell(DOMWrapperWorld* world) const
95     {
96         ShellMap::const_iterator iter = m_windowShells.find(world);
97         return (iter != m_windowShells.end()) ? iter->second.get() : 0;
98     }
99     JSDOMWindow* globalObject(DOMWrapperWorld* world)
100     {
101         return windowShell(world)->window();
102     }
103
104     static void getAllWorlds(Vector<DOMWrapperWorld*>&);
105
106     ScriptValue executeScript(const ScriptSourceCode&, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);
107     ScriptValue executeScript(const String& script, bool forceUserGesture = false, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);
108     ScriptValue executeScriptInWorld(DOMWrapperWorld* world, const String& script, bool forceUserGesture = false, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);
109
110     // Returns true if argument is a JavaScript URL.
111     bool executeIfJavaScriptURL(const KURL&, bool userGesture = false, ShouldReplaceDocumentIfJavaScriptURL shouldReplaceDocumentIfJavaScriptURL = ReplaceDocumentIfJavaScriptURL);
112
113     // This function must be called from the main thread. It is safe to call it repeatedly.
114     // Darwin is an exception to this rule: it is OK to call this function from any thread, even reentrantly.
115     static void initializeThreading();
116
117     ScriptValue evaluate(const ScriptSourceCode&, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);
118     ScriptValue evaluateInWorld(const ScriptSourceCode&, DOMWrapperWorld*, ShouldAllowXSS shouldAllowXSS = DoNotAllowXSS);
119
120     void setEventHandlerLineNumber(int lineno) { m_handlerLineNumber = lineno; }
121     int eventHandlerLineNumber() { return m_handlerLineNumber; }
122
123     void setProcessingTimerCallback(bool b) { m_processingTimerCallback = b; }
124     bool processingUserGesture(DOMWrapperWorld*) const;
125     bool anyPageIsProcessingUserGesture() const;
126
127     static bool canAccessFromCurrentOrigin(Frame*);
128     bool canExecuteScripts(ReasonForCallingCanExecuteScripts);
129
130     // Debugger can be 0 to detach any existing Debugger.
131     void attachDebugger(JSC::Debugger*); // Attaches/detaches in all worlds/window shells.
132     void attachDebugger(JSDOMWindowShell*, JSC::Debugger*);
133
134     void setPaused(bool b) { m_paused = b; }
135     bool isPaused() const { return m_paused; }
136
137     void setAllowPopupsFromPlugin(bool allowPopupsFromPlugin) { m_allowPopupsFromPlugin = allowPopupsFromPlugin; }
138     bool allowPopupsFromPlugin() const { return m_allowPopupsFromPlugin; }
139     
140     const String* sourceURL() const { return m_sourceURL; } // 0 if we are not evaluating any script
141
142     void clearWindowShell(bool goingIntoPageCache = false);
143     void updateDocument();
144
145     // Notifies the ScriptController that the securityOrigin of the current
146     // document was modified.  For example, this method is called when
147     // document.domain is set.  This method is *not* called when a new document
148     // is attached to a frame because updateDocument() is called instead.
149     void updateSecurityOrigin();
150
151     void clearScriptObjects();
152     void cleanupScriptObjectsForPlugin(void*);
153
154     void updatePlatformScriptObjects();
155
156     PassScriptInstance createScriptInstanceForWidget(Widget*);
157     JSC::Bindings::RootObject* bindingRootObject();
158
159     PassRefPtr<JSC::Bindings::RootObject> createRootObject(void* nativeHandle);
160
161 #if PLATFORM(MAC)
162 #if ENABLE(JAVA_BRIDGE)
163     static void initJavaJSBindings();
164 #endif
165     WebScriptObject* windowScriptObject();
166 #endif
167
168     JSC::JSObject* jsObjectForPluginElement(HTMLPlugInElement*);
169     
170 #if ENABLE(NETSCAPE_PLUGIN_API)
171     NPObject* createScriptObjectForPluginElement(HTMLPlugInElement*);
172     NPObject* windowScriptNPObject();
173 #endif
174     
175     XSSAuditor* xssAuditor() { return m_XSSAuditor.get(); }
176
177 private:
178     JSDOMWindowShell* initScript(DOMWrapperWorld* world);
179
180     void disconnectPlatformScriptObjects();
181
182     bool isJavaScriptAnchorNavigation() const;
183
184     ShellMap m_windowShells;
185     Frame* m_frame;
186     int m_handlerLineNumber;
187     const String* m_sourceURL;
188
189     bool m_inExecuteScript;
190
191     bool m_processingTimerCallback;
192     bool m_paused;
193     bool m_allowPopupsFromPlugin;
194
195     // The root object used for objects bound outside the context of a plugin.
196     RefPtr<JSC::Bindings::RootObject> m_bindingRootObject;
197     RootObjectMap m_rootObjects;
198 #if ENABLE(NETSCAPE_PLUGIN_API)
199     NPObject* m_windowScriptNPObject;
200 #endif
201 #if PLATFORM(MAC)
202     RetainPtr<WebScriptObject> m_windowScriptObject;
203 #endif
204     
205     // The XSSAuditor associated with this ScriptController.
206     OwnPtr<XSSAuditor> m_XSSAuditor;
207 };
208
209 } // namespace WebCore
210
211 #endif // ScriptController_h