blob: 7a2b4f23b6f5181bbd68ae5da9f8125589112bd5 [file] [log] [blame]
/*
* Copyright (C) 1999 Harri Porten (porten@kde.org)
* Copyright (C) 2001 Peter Kelly (pmk@post.com)
* Copyright (C) 2008-2019 Apple Inc. All rights reserved.
* Copyright (C) 2008 Eric Seidel <eric@webkit.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#pragma once
#include "FrameLoaderTypes.h"
#include "JSWindowProxy.h"
#include "SerializedScriptValue.h"
#include "WindowProxy.h"
#include <JavaScriptCore/JSBase.h>
#include <JavaScriptCore/Strong.h>
#include <wtf/Forward.h>
#include <wtf/Optional.h>
#include <wtf/RefPtr.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/TextPosition.h>
#if PLATFORM(COCOA)
#include <wtf/RetainPtr.h>
OBJC_CLASS JSContext;
OBJC_CLASS WebScriptObject;
#endif
struct NPObject;
namespace JSC {
class CallFrame;
class JSGlobalObject;
class JSInternalPromise;
class JSModuleRecord;
namespace Bindings {
class Instance;
class RootObject;
}
}
namespace WebCore {
class CachedScriptFetcher;
class Frame;
class HTMLDocument;
class HTMLPlugInElement;
class LoadableModuleScript;
class ModuleFetchParameters;
class ScriptSourceCode;
class SecurityOrigin;
class Widget;
enum class RunAsAsyncFunction : bool;
struct ExceptionDetails;
struct RunJavaScriptParameters;
enum ReasonForCallingCanExecuteScripts {
AboutToCreateEventListener,
AboutToExecuteScript,
NotAboutToExecuteScript
};
using ValueOrException = Expected<JSC::JSValue, ExceptionDetails>;
class ScriptController : public CanMakeWeakPtr<ScriptController> {
WTF_MAKE_FAST_ALLOCATED;
using RootObjectMap = HashMap<void*, Ref<JSC::Bindings::RootObject>>;
public:
explicit ScriptController(Frame&);
~ScriptController();
WEBCORE_EXPORT static Ref<DOMWrapperWorld> createWorld();
JSDOMWindow* globalObject(DOMWrapperWorld& world)
{
return JSC::jsCast<JSDOMWindow*>(jsWindowProxy(world).window());
}
static void getAllWorlds(Vector<Ref<DOMWrapperWorld>>&);
using ResolveFunction = CompletionHandler<void(ValueOrException)>;
WEBCORE_EXPORT JSC::JSValue executeScriptIgnoringException(const String& script, bool forceUserGesture = false);
JSC::JSValue executeScriptInWorldIgnoringException(DOMWrapperWorld&, const String& script, bool forceUserGesture = false);
WEBCORE_EXPORT JSC::JSValue executeUserAgentScriptInWorldIgnoringException(DOMWrapperWorld&, const String& script, bool forceUserGesture);
WEBCORE_EXPORT ValueOrException executeUserAgentScriptInWorld(DOMWrapperWorld&, const String& script, bool forceUserGesture);
WEBCORE_EXPORT void executeAsynchronousUserAgentScriptInWorld(DOMWrapperWorld&, RunJavaScriptParameters&&, ResolveFunction&&);
JSC::JSValue evaluateIgnoringException(const ScriptSourceCode&);
JSC::JSValue evaluateInWorldIgnoringException(const ScriptSourceCode&, DOMWrapperWorld&);
Expected<void, ExceptionDetails> shouldAllowUserAgentScripts(Document&) const;
// Returns true if argument is a JavaScript URL.
bool executeIfJavaScriptURL(const URL&, RefPtr<SecurityOrigin> = nullptr, ShouldReplaceDocumentIfJavaScriptURL = ReplaceDocumentIfJavaScriptURL);
// This function must be called from the main thread. It is safe to call it repeatedly.
// Darwin is an exception to this rule: it is OK to call this function from any thread, even reentrantly.
static void initializeThreading();
void loadModuleScriptInWorld(LoadableModuleScript&, const String& moduleName, Ref<ModuleFetchParameters>&&, DOMWrapperWorld&);
void loadModuleScript(LoadableModuleScript&, const String& moduleName, Ref<ModuleFetchParameters>&&);
void loadModuleScriptInWorld(LoadableModuleScript&, const ScriptSourceCode&, DOMWrapperWorld&);
void loadModuleScript(LoadableModuleScript&, const ScriptSourceCode&);
JSC::JSValue linkAndEvaluateModuleScriptInWorld(LoadableModuleScript& , DOMWrapperWorld&);
JSC::JSValue linkAndEvaluateModuleScript(LoadableModuleScript&);
JSC::JSValue evaluateModule(const URL&, JSC::JSModuleRecord&, DOMWrapperWorld&);
JSC::JSValue evaluateModule(const URL&, JSC::JSModuleRecord&);
WTF::TextPosition eventHandlerPosition() const;
void enableEval();
void enableWebAssembly();
void disableEval(const String& errorMessage);
void disableWebAssembly(const String& errorMessage);
static bool canAccessFromCurrentOrigin(Frame*, Document& accessingDocument);
WEBCORE_EXPORT bool canExecuteScripts(ReasonForCallingCanExecuteScripts);
void setPaused(bool b) { m_paused = b; }
bool isPaused() const { return m_paused; }
const String* sourceURL() const { return m_sourceURL; } // 0 if we are not evaluating any script
void updateDocument();
void namedItemAdded(HTMLDocument*, const AtomString&) { }
void namedItemRemoved(HTMLDocument*, const AtomString&) { }
void clearScriptObjects();
WEBCORE_EXPORT void cleanupScriptObjectsForPlugin(void*);
void updatePlatformScriptObjects();
RefPtr<JSC::Bindings::Instance> createScriptInstanceForWidget(Widget*);
WEBCORE_EXPORT JSC::Bindings::RootObject* bindingRootObject();
JSC::Bindings::RootObject* cacheableBindingRootObject();
JSC::Bindings::RootObject* existingCacheableBindingRootObject() const { return m_cacheableBindingRootObject.get(); }
WEBCORE_EXPORT Ref<JSC::Bindings::RootObject> createRootObject(void* nativeHandle);
void collectIsolatedContexts(Vector<std::pair<JSC::JSGlobalObject*, SecurityOrigin*>>&);
#if PLATFORM(COCOA)
WEBCORE_EXPORT WebScriptObject* windowScriptObject();
WEBCORE_EXPORT JSContext *javaScriptContext();
#endif
WEBCORE_EXPORT JSC::JSObject* jsObjectForPluginElement(HTMLPlugInElement*);
#if ENABLE(NETSCAPE_PLUGIN_API)
WEBCORE_EXPORT NPObject* windowScriptNPObject();
#endif
void initScriptForWindowProxy(JSWindowProxy&);
bool willReplaceWithResultOfExecutingJavascriptURL() const { return m_willReplaceWithResultOfExecutingJavascriptURL; }
private:
ValueOrException executeUserAgentScriptInWorldInternal(DOMWrapperWorld&, RunJavaScriptParameters&&);
ValueOrException executeScriptInWorld(DOMWrapperWorld&, RunJavaScriptParameters&&);
ValueOrException evaluateInWorld(const ScriptSourceCode&, DOMWrapperWorld&);
ValueOrException callInWorld(RunJavaScriptParameters&&, DOMWrapperWorld&);
void setupModuleScriptHandlers(LoadableModuleScript&, JSC::JSInternalPromise&, DOMWrapperWorld&);
void disconnectPlatformScriptObjects();
WEBCORE_EXPORT WindowProxy& windowProxy();
WEBCORE_EXPORT JSWindowProxy& jsWindowProxy(DOMWrapperWorld&);
Frame& m_frame;
const String* m_sourceURL;
bool m_paused;
bool m_willReplaceWithResultOfExecutingJavascriptURL { false };
// The root object used for objects bound outside the context of a plugin, such
// as NPAPI plugins. The plugins using these objects prevent a page from being cached so they
// are safe to invalidate() when WebKit navigates away from the page that contains them.
RefPtr<JSC::Bindings::RootObject> m_bindingRootObject;
// Unlike m_bindingRootObject these objects are used in pages that are cached, so they are not invalidate()'d.
// This ensures they are still available when the page is restored.
RefPtr<JSC::Bindings::RootObject> m_cacheableBindingRootObject;
RootObjectMap m_rootObjects;
#if ENABLE(NETSCAPE_PLUGIN_API)
NPObject* m_windowScriptNPObject;
#endif
#if PLATFORM(COCOA)
RetainPtr<WebScriptObject> m_windowScriptObject;
#endif
};
} // namespace WebCore