contentfiltering tests leak documents
[WebKit-https.git] / Source / 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-2017 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 #pragma once
23
24 #include "FrameLoaderTypes.h"
25 #include "JSWindowProxy.h"
26 #include "WindowProxy.h"
27 #include <JavaScriptCore/JSBase.h>
28 #include <JavaScriptCore/Strong.h>
29 #include <wtf/Forward.h>
30 #include <wtf/RefPtr.h>
31 #include <wtf/WeakPtr.h>
32 #include <wtf/text/TextPosition.h>
33
34 #if PLATFORM(COCOA)
35 #include <wtf/RetainPtr.h>
36 OBJC_CLASS JSContext;
37 OBJC_CLASS WebScriptObject;
38 #endif
39
40 struct NPObject;
41
42 namespace JSC {
43 class ExecState;
44 class JSGlobalObject;
45 class JSInternalPromise;
46 class JSModuleRecord;
47
48 namespace Bindings {
49 class Instance;
50 class RootObject;
51 }
52 }
53
54 namespace WebCore {
55
56 class CachedScriptFetcher;
57 class Frame;
58 class HTMLDocument;
59 class HTMLPlugInElement;
60 class LoadableModuleScript;
61 class ModuleFetchParameters;
62 class ScriptSourceCode;
63 class SecurityOrigin;
64 class Widget;
65 struct ExceptionDetails;
66
67 enum ReasonForCallingCanExecuteScripts {
68     AboutToCreateEventListener,
69     AboutToExecuteScript,
70     NotAboutToExecuteScript
71 };
72
73 class ScriptController : public CanMakeWeakPtr<ScriptController> {
74     WTF_MAKE_FAST_ALLOCATED;
75
76     using RootObjectMap = HashMap<void*, Ref<JSC::Bindings::RootObject>>;
77
78 public:
79     explicit ScriptController(Frame&);
80     ~ScriptController();
81
82     WEBCORE_EXPORT static Ref<DOMWrapperWorld> createWorld();
83
84     JSDOMWindow* globalObject(DOMWrapperWorld& world)
85     {
86         return JSC::jsCast<JSDOMWindow*>(jsWindowProxy(world).window());
87     }
88
89     static void getAllWorlds(Vector<Ref<DOMWrapperWorld>>&);
90
91     JSC::JSValue executeScript(const ScriptSourceCode&, ExceptionDetails* = nullptr);
92     WEBCORE_EXPORT JSC::JSValue executeScript(const String& script, bool forceUserGesture = false, ExceptionDetails* = nullptr);
93     WEBCORE_EXPORT JSC::JSValue executeScriptInWorld(DOMWrapperWorld&, const String& script, bool forceUserGesture = false, ExceptionDetails* = nullptr);
94
95     // Returns true if argument is a JavaScript URL.
96     bool executeIfJavaScriptURL(const URL&, ShouldReplaceDocumentIfJavaScriptURL shouldReplaceDocumentIfJavaScriptURL = ReplaceDocumentIfJavaScriptURL);
97
98     // This function must be called from the main thread. It is safe to call it repeatedly.
99     // Darwin is an exception to this rule: it is OK to call this function from any thread, even reentrantly.
100     static void initializeThreading();
101
102     JSC::JSValue evaluate(const ScriptSourceCode&, ExceptionDetails* = nullptr);
103     JSC::JSValue evaluateInWorld(const ScriptSourceCode&, DOMWrapperWorld&, ExceptionDetails* = nullptr);
104
105     void loadModuleScriptInWorld(LoadableModuleScript&, const String& moduleName, Ref<ModuleFetchParameters>&&, DOMWrapperWorld&);
106     void loadModuleScript(LoadableModuleScript&, const String& moduleName, Ref<ModuleFetchParameters>&&);
107     void loadModuleScriptInWorld(LoadableModuleScript&, const ScriptSourceCode&, DOMWrapperWorld&);
108     void loadModuleScript(LoadableModuleScript&, const ScriptSourceCode&);
109
110     JSC::JSValue linkAndEvaluateModuleScriptInWorld(LoadableModuleScript& , DOMWrapperWorld&);
111     JSC::JSValue linkAndEvaluateModuleScript(LoadableModuleScript&);
112
113     JSC::JSValue evaluateModule(const URL&, JSC::JSModuleRecord&, DOMWrapperWorld&);
114     JSC::JSValue evaluateModule(const URL&, JSC::JSModuleRecord&);
115
116     WTF::TextPosition eventHandlerPosition() const;
117
118     void enableEval();
119     void enableWebAssembly();
120     void disableEval(const String& errorMessage);
121     void disableWebAssembly(const String& errorMessage);
122
123     static bool canAccessFromCurrentOrigin(Frame*);
124     WEBCORE_EXPORT bool canExecuteScripts(ReasonForCallingCanExecuteScripts);
125
126     void setPaused(bool b) { m_paused = b; }
127     bool isPaused() const { return m_paused; }
128
129     const String* sourceURL() const { return m_sourceURL; } // 0 if we are not evaluating any script
130
131     void updateDocument();
132
133     void namedItemAdded(HTMLDocument*, const AtomicString&) { }
134     void namedItemRemoved(HTMLDocument*, const AtomicString&) { }
135
136     void clearScriptObjects();
137     WEBCORE_EXPORT void cleanupScriptObjectsForPlugin(void*);
138
139     void updatePlatformScriptObjects();
140
141     RefPtr<JSC::Bindings::Instance>  createScriptInstanceForWidget(Widget*);
142     WEBCORE_EXPORT JSC::Bindings::RootObject* bindingRootObject();
143     JSC::Bindings::RootObject* cacheableBindingRootObject();
144     JSC::Bindings::RootObject* existingCacheableBindingRootObject() const { return m_cacheableBindingRootObject.get(); }
145
146     WEBCORE_EXPORT Ref<JSC::Bindings::RootObject> createRootObject(void* nativeHandle);
147
148     void collectIsolatedContexts(Vector<std::pair<JSC::ExecState*, SecurityOrigin*>>&);
149
150 #if PLATFORM(COCOA)
151     WEBCORE_EXPORT WebScriptObject* windowScriptObject();
152     WEBCORE_EXPORT JSContext *javaScriptContext();
153 #endif
154
155     WEBCORE_EXPORT JSC::JSObject* jsObjectForPluginElement(HTMLPlugInElement*);
156     
157 #if ENABLE(NETSCAPE_PLUGIN_API)
158     WEBCORE_EXPORT NPObject* windowScriptNPObject();
159 #endif
160
161     void initScriptForWindowProxy(JSWindowProxy&);
162
163 private:
164     void setupModuleScriptHandlers(LoadableModuleScript&, JSC::JSInternalPromise&, DOMWrapperWorld&);
165
166     void disconnectPlatformScriptObjects();
167
168     WEBCORE_EXPORT WindowProxy& windowProxy();
169     WEBCORE_EXPORT JSWindowProxy& jsWindowProxy(DOMWrapperWorld&);
170
171     Frame& m_frame;
172     const String* m_sourceURL;
173
174     bool m_paused;
175
176     // The root object used for objects bound outside the context of a plugin, such
177     // as NPAPI plugins. The plugins using these objects prevent a page from being cached so they
178     // are safe to invalidate() when WebKit navigates away from the page that contains them.
179     RefPtr<JSC::Bindings::RootObject> m_bindingRootObject;
180     // Unlike m_bindingRootObject these objects are used in pages that are cached, so they are not invalidate()'d.
181     // This ensures they are still available when the page is restored.
182     RefPtr<JSC::Bindings::RootObject> m_cacheableBindingRootObject;
183     RootObjectMap m_rootObjects;
184 #if ENABLE(NETSCAPE_PLUGIN_API)
185     NPObject* m_windowScriptNPObject;
186 #endif
187 #if PLATFORM(COCOA)
188     RetainPtr<WebScriptObject> m_windowScriptObject;
189 #endif
190 };
191
192 } // namespace WebCore