bfdcaaffd7ed5a2df315ee712912df022bcee46e
[WebKit-https.git] / WebCore / bindings / js / ScriptController.cpp
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
4  *  Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
5  *
6  *  This library is free software; you can redistribute it and/or
7  *  modify it under the terms of the GNU Lesser General Public
8  *  License as published by the Free Software Foundation; either
9  *  version 2 of the License, or (at your option) any later version.
10  *
11  *  This library is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  *  Lesser General Public License for more details.
15  *
16  *  You should have received a copy of the GNU Lesser General Public
17  *  License along with this library; if not, write to the Free Software
18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
19  */
20
21 #include "config.h"
22 #include "ScriptController.h"
23
24 #include "CString.h"
25 #include "Event.h"
26 #include "EventNames.h"
27 #include "Frame.h"
28 #include "FrameLoaderClient.h"
29 #include "GCController.h"
30 #include "HTMLPlugInElement.h"
31 #include "InspectorTimelineAgent.h"
32 #include "JSDocument.h"
33 #include "NP_jsobject.h"
34 #include "Page.h"
35 #include "PageGroup.h"
36 #include "ScriptSourceCode.h"
37 #include "ScriptValue.h"
38 #include "Settings.h"
39 #include "StorageNamespace.h"
40 #include "XSSAuditor.h"
41 #include "npruntime_impl.h"
42 #include "runtime_root.h"
43 #include <debugger/Debugger.h>
44 #include <runtime/InitializeThreading.h>
45 #include <runtime/JSLock.h>
46
47 using namespace JSC;
48 using namespace std;
49
50 namespace WebCore {
51
52 void ScriptController::initializeThreading()
53 {
54     JSC::initializeThreading();
55 }
56
57 ScriptController::ScriptController(Frame* frame)
58     : m_frame(frame)
59     , m_handlerLineNumber(0)
60     , m_sourceURL(0)
61     , m_inExecuteScript(false)
62     , m_processingTimerCallback(false)
63     , m_paused(false)
64     , m_allowPopupsFromPlugin(false)
65 #if ENABLE(NETSCAPE_PLUGIN_API)
66     , m_windowScriptNPObject(0)
67 #endif
68 #if PLATFORM(MAC)
69     , m_windowScriptObject(0)
70 #endif
71     , m_XSSAuditor(new XSSAuditor(frame))
72 {
73 #if PLATFORM(MAC) && ENABLE(MAC_JAVA_BRIDGE)
74     static bool initializedJavaJSBindings;
75     if (!initializedJavaJSBindings) {
76         initializedJavaJSBindings = true;
77         initJavaJSBindings();
78     }
79 #endif
80 }
81
82 ScriptController::~ScriptController()
83 {
84     if (!m_windowShells.isEmpty()) {
85         m_windowShells.clear();
86     
87         // It's likely that releasing the global object has created a lot of garbage.
88         gcController().garbageCollectSoon();
89     }
90
91     disconnectPlatformScriptObjects();
92 }
93
94 ScriptValue ScriptController::evaluateInWorld(const ScriptSourceCode& sourceCode, DOMWrapperWorld* world)
95 {
96     const SourceCode& jsSourceCode = sourceCode.jsSourceCode();
97     String sourceURL = jsSourceCode.provider()->url();
98
99     if (!m_XSSAuditor->canEvaluate(sourceCode.source())) {
100         // This script is not safe to be evaluated.
101         return JSValue();
102     }
103
104     // evaluate code. Returns the JS return value or 0
105     // if there was none, an error occured or the type couldn't be converted.
106
107     // inlineCode is true for <a href="javascript:doSomething()">
108     // and false for <script>doSomething()</script>. Check if it has the
109     // expected value in all cases.
110     // See smart window.open policy for where this is used.
111     JSDOMWindowShell* shell = windowShell(world);
112     ExecState* exec = shell->window()->globalExec();
113     const String* savedSourceURL = m_sourceURL;
114     m_sourceURL = &sourceURL;
115
116     JSLock lock(SilenceAssertionsOnly);
117
118     RefPtr<Frame> protect = m_frame;
119
120 #if ENABLE(INSPECTOR)
121     if (InspectorTimelineAgent* timelineAgent = m_frame->page() ? m_frame->page()->inspectorTimelineAgent() : 0)
122         timelineAgent->willEvaluateScript(sourceURL, sourceCode.startLine());
123 #endif
124
125     exec->globalData().timeoutChecker.start();
126     Completion comp = JSC::evaluate(exec, exec->dynamicGlobalObject()->globalScopeChain(), jsSourceCode, shell);
127     exec->globalData().timeoutChecker.stop();
128
129 #if ENABLE(INSPECTOR)
130     if (InspectorTimelineAgent* timelineAgent = m_frame->page() ? m_frame->page()->inspectorTimelineAgent() : 0)
131         timelineAgent->didEvaluateScript();
132 #endif
133
134     // Evaluating the JavaScript could cause the frame to be deallocated
135     // so we start the keep alive timer here.
136     m_frame->keepAlive();
137
138     if (comp.complType() == Normal || comp.complType() == ReturnValue) {
139         m_sourceURL = savedSourceURL;
140         return comp.value();
141     }
142
143     if (comp.complType() == Throw || comp.complType() == Interrupted)
144         reportException(exec, comp.value());
145
146     m_sourceURL = savedSourceURL;
147     return JSValue();
148 }
149
150 ScriptValue ScriptController::evaluate(const ScriptSourceCode& sourceCode) 
151 {
152     return evaluateInWorld(sourceCode, mainThreadNormalWorld());
153 }
154
155 // An DOMWrapperWorld other than the thread's normal world.
156 class IsolatedWorld : public DOMWrapperWorld {
157 public:
158     IsolatedWorld(JSGlobalData* globalData)
159         : DOMWrapperWorld(globalData, false)
160     {
161         JSGlobalData::ClientData* clientData = globalData->clientData;
162         ASSERT(clientData);
163         static_cast<WebCoreJSClientData*>(clientData)->rememberWorld(this);
164     }
165
166     static PassRefPtr<IsolatedWorld> create(JSGlobalData* globalData) { return adoptRef(new IsolatedWorld(globalData)); }
167 };
168
169 PassRefPtr<DOMWrapperWorld> ScriptController::createWorld()
170 {
171     return IsolatedWorld::create(JSDOMWindow::commonJSGlobalData());
172 }
173
174 void ScriptController::getAllWorlds(Vector<DOMWrapperWorld*>& worlds)
175 {
176     static_cast<WebCoreJSClientData*>(JSDOMWindow::commonJSGlobalData()->clientData)->getAllWorlds(worlds);
177 }
178
179 void ScriptController::clearWindowShell()
180 {
181     if (m_windowShells.isEmpty())
182         return;
183
184     JSLock lock(SilenceAssertionsOnly);
185
186     // Clear the debugger from the current window before setting the new window.
187     DOMWrapperWorld* debugWorld = debuggerWorld();
188     attachDebugger(0);
189
190     for (ShellMap::iterator iter = m_windowShells.begin(); iter != m_windowShells.end(); ++iter) {
191         DOMWrapperWorld* world = iter->first.get();
192         JSDOMWindowShell* windowShell = iter->second;
193         windowShell->window()->willRemoveFromWindowShell();
194         windowShell->setWindow(m_frame->domWindow());
195
196         if (Page* page = m_frame->page()) {
197             if (world == debugWorld)
198                 attachDebugger(page->debugger());
199             windowShell->window()->setProfileGroup(page->group().identifier());
200         }
201     }
202
203     // There is likely to be a lot of garbage now.
204     gcController().garbageCollectSoon();
205 }
206
207 JSDOMWindowShell* ScriptController::initScript(DOMWrapperWorld* world)
208 {
209     ASSERT(!m_windowShells.contains(world));
210
211     JSLock lock(SilenceAssertionsOnly);
212
213     JSDOMWindowShell* windowShell = new JSDOMWindowShell(m_frame->domWindow(), world);
214     m_windowShells.add(world, windowShell);
215     windowShell->window()->updateDocument();
216
217     if (Page* page = m_frame->page()) {
218         if (world == debuggerWorld())
219             attachDebugger(page->debugger());
220         windowShell->window()->setProfileGroup(page->group().identifier());
221     }
222
223     m_frame->loader()->dispatchDidClearWindowObjectInWorld(world);
224
225     return windowShell;
226 }
227
228 bool ScriptController::processingUserGesture() const
229 {
230     return m_allowPopupsFromPlugin || processingUserGestureEvent() || isJavaScriptAnchorNavigation();
231 }
232
233 bool ScriptController::processingUserGestureEvent() const
234 {
235     JSDOMWindowShell* shell = existingWindowShell(mainThreadNormalWorld());
236     if (!shell)
237         return false;
238
239     if (Event* event = shell->window()->currentEvent()) {
240         if (event->createdByDOM())
241             return false;
242
243         const AtomicString& type = event->type();
244         if ( // mouse events
245             type == eventNames().clickEvent || type == eventNames().mousedownEvent 
246             || type == eventNames().mouseupEvent || type == eventNames().dblclickEvent 
247             // keyboard events
248             || type == eventNames().keydownEvent || type == eventNames().keypressEvent
249             || type == eventNames().keyupEvent
250 #if ENABLE(TOUCH_EVENTS)
251             // touch events
252             || type == eventNames().touchstartEvent || type == eventNames().touchmoveEvent
253             || type == eventNames().touchendEvent
254 #endif
255             // other accepted events
256             || type == eventNames().selectEvent || type == eventNames().changeEvent
257             || type == eventNames().focusEvent || type == eventNames().blurEvent
258             || type == eventNames().submitEvent)
259             return true;
260     }
261     
262     return false;
263 }
264
265 // FIXME: This seems like an insufficient check to verify a click on a javascript: anchor.
266 bool ScriptController::isJavaScriptAnchorNavigation() const
267 {
268     // This is the <a href="javascript:window.open('...')> case -> we let it through
269     if (m_sourceURL && m_sourceURL->isNull() && !m_processingTimerCallback)
270         return true;
271
272     // This is the <script>window.open(...)</script> case or a timer callback -> block it
273     return false;
274 }
275
276 bool ScriptController::anyPageIsProcessingUserGesture() const
277 {
278     Page* page = m_frame->page();
279     if (!page)
280         return false;
281
282     const HashSet<Page*>& pages = page->group().pages();
283     HashSet<Page*>::const_iterator end = pages.end();
284     for (HashSet<Page*>::const_iterator it = pages.begin(); it != end; ++it) {
285         for (Frame* frame = page->mainFrame(); frame; frame = frame->tree()->traverseNext()) {
286             if (frame->script()->processingUserGesture())
287                 return true;
288         }
289     }
290
291     return false;
292 }
293
294 void ScriptController::attachDebugger(JSC::Debugger* debugger)
295 {
296     // FIXME: Should be able to debug isolated worlds.
297     JSDOMWindowShell* shell = existingWindowShell(debuggerWorld());
298     if (!shell)
299         return;
300
301     JSDOMWindow* globalObject = shell->window();
302     if (debugger)
303         debugger->attach(globalObject);
304     else if (JSC::Debugger* currentDebugger = globalObject->debugger())
305         currentDebugger->detach(globalObject);
306 }
307
308 void ScriptController::updateDocument()
309 {
310     if (!m_frame->document())
311         return;
312
313     JSLock lock(SilenceAssertionsOnly);
314     for (ShellMap::iterator iter = m_windowShells.begin(); iter != m_windowShells.end(); ++iter)
315         iter->second->window()->updateDocument();
316 }
317
318 void ScriptController::updateSecurityOrigin()
319 {
320     // Our bindings do not do anything in this case.
321 }
322
323 Bindings::RootObject* ScriptController::bindingRootObject()
324 {
325     if (!canExecuteScripts())
326         return 0;
327
328     if (!m_bindingRootObject) {
329         JSLock lock(SilenceAssertionsOnly);
330         m_bindingRootObject = Bindings::RootObject::create(0, globalObject(pluginWorld()));
331     }
332     return m_bindingRootObject.get();
333 }
334
335 PassRefPtr<Bindings::RootObject> ScriptController::createRootObject(void* nativeHandle)
336 {
337     RootObjectMap::iterator it = m_rootObjects.find(nativeHandle);
338     if (it != m_rootObjects.end())
339         return it->second;
340
341     RefPtr<Bindings::RootObject> rootObject = Bindings::RootObject::create(nativeHandle, globalObject(pluginWorld()));
342
343     m_rootObjects.set(nativeHandle, rootObject);
344     return rootObject.release();
345 }
346
347 #if ENABLE(NETSCAPE_PLUGIN_API)
348
349 NPObject* ScriptController::windowScriptNPObject()
350 {
351     if (!m_windowScriptNPObject) {
352         if (canExecuteScripts()) {
353             // JavaScript is enabled, so there is a JavaScript window object.
354             // Return an NPObject bound to the window object.
355             JSC::JSLock lock(SilenceAssertionsOnly);
356             JSObject* win = windowShell(pluginWorld())->window();
357             ASSERT(win);
358             Bindings::RootObject* root = bindingRootObject();
359             m_windowScriptNPObject = _NPN_CreateScriptObject(0, win, root);
360         } else {
361             // JavaScript is not enabled, so we cannot bind the NPObject to the JavaScript window object.
362             // Instead, we create an NPObject of a different class, one which is not bound to a JavaScript object.
363             m_windowScriptNPObject = _NPN_CreateNoScriptObject();
364         }
365     }
366
367     return m_windowScriptNPObject;
368 }
369
370 NPObject* ScriptController::createScriptObjectForPluginElement(HTMLPlugInElement* plugin)
371 {
372     JSObject* object = jsObjectForPluginElement(plugin);
373     if (!object)
374         return _NPN_CreateNoScriptObject();
375
376     // Wrap the JSObject in an NPObject
377     return _NPN_CreateScriptObject(0, object, bindingRootObject());
378 }
379
380 #endif
381
382 JSObject* ScriptController::jsObjectForPluginElement(HTMLPlugInElement* plugin)
383 {
384     // Can't create JSObjects when JavaScript is disabled
385     if (!canExecuteScripts())
386         return 0;
387
388     // Create a JSObject bound to this element
389     JSLock lock(SilenceAssertionsOnly);
390     JSDOMWindow* globalObj = globalObject(pluginWorld());
391     // FIXME: is normal okay? - used for NP plugins?
392     JSValue jsElementValue = toJS(globalObj->globalExec(), globalObj, plugin);
393     if (!jsElementValue || !jsElementValue.isObject())
394         return 0;
395     
396     return jsElementValue.getObject();
397 }
398
399 #if !PLATFORM(MAC)
400
401 void ScriptController::updatePlatformScriptObjects()
402 {
403 }
404
405 void ScriptController::disconnectPlatformScriptObjects()
406 {
407 }
408
409 #endif
410
411 void ScriptController::cleanupScriptObjectsForPlugin(void* nativeHandle)
412 {
413     RootObjectMap::iterator it = m_rootObjects.find(nativeHandle);
414
415     if (it == m_rootObjects.end())
416         return;
417
418     it->second->invalidate();
419     m_rootObjects.remove(it);
420 }
421
422 void ScriptController::clearScriptObjects()
423 {
424     JSLock lock(SilenceAssertionsOnly);
425
426     RootObjectMap::const_iterator end = m_rootObjects.end();
427     for (RootObjectMap::const_iterator it = m_rootObjects.begin(); it != end; ++it)
428         it->second->invalidate();
429
430     m_rootObjects.clear();
431
432     if (m_bindingRootObject) {
433         m_bindingRootObject->invalidate();
434         m_bindingRootObject = 0;
435     }
436
437 #if ENABLE(NETSCAPE_PLUGIN_API)
438     if (m_windowScriptNPObject) {
439         // Call _NPN_DeallocateObject() instead of _NPN_ReleaseObject() so that we don't leak if a plugin fails to release the window
440         // script object properly.
441         // This shouldn't cause any problems for plugins since they should have already been stopped and destroyed at this point.
442         _NPN_DeallocateObject(m_windowScriptNPObject);
443         m_windowScriptNPObject = 0;
444     }
445 #endif
446 }
447
448 ScriptValue ScriptController::executeScriptInWorld(DOMWrapperWorld* world, const String& script, bool forceUserGesture)
449 {
450     ScriptSourceCode sourceCode(script, forceUserGesture ? KURL() : m_frame->loader()->url());
451
452     if (!canExecuteScripts() || isPaused())
453         return ScriptValue();
454
455     bool wasInExecuteScript = m_inExecuteScript;
456     m_inExecuteScript = true;
457
458     ScriptValue result = evaluateInWorld(sourceCode, world);
459
460     if (!wasInExecuteScript) {
461         m_inExecuteScript = false;
462         Document::updateStyleForAllDocuments();
463     }
464
465     return result;
466 }
467
468 } // namespace WebCore