206bd2edb0fae3d397978ebbbcbb41b2062d7ab1
[WebKit-https.git] / Source / WebCore / bindings / js / JSEventListener.cpp
1 /*
2  *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  *  Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2013 Apple Inc. All Rights Reserved.
4  *
5  *  This library is free software; you can redistribute it and/or
6  *  modify it under the terms of the GNU Lesser General Public
7  *  License as published by the Free Software Foundation; either
8  *  version 2 of the License, or (at your option) any later version.
9  *
10  *  This library is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  *  Lesser General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Lesser General Public
16  *  License along with this library; if not, write to the Free Software
17  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
18  */
19
20 #include "config.h"
21 #include "JSEventListener.h"
22
23 #include "BeforeUnloadEvent.h"
24 #include "ContentSecurityPolicy.h"
25 #include "Event.h"
26 #include "Frame.h"
27 #include "HTMLElement.h"
28 #include "JSDocument.h"
29 #include "JSEvent.h"
30 #include "JSEventTarget.h"
31 #include "JSMainThreadExecState.h"
32 #include "JSMainThreadExecStateInstrumentation.h"
33 #include "ScriptController.h"
34 #include "WorkerGlobalScope.h"
35 #include <runtime/ExceptionHelpers.h>
36 #include <runtime/JSLock.h>
37 #include <runtime/VMEntryScope.h>
38 #include <runtime/Watchdog.h>
39 #include <wtf/Ref.h>
40
41 using namespace JSC;
42
43 namespace WebCore {
44
45 JSEventListener::JSEventListener(JSObject* function, JSObject* wrapper, bool isAttribute, DOMWrapperWorld& isolatedWorld)
46     : EventListener(JSEventListenerType)
47     , m_wrapper(wrapper)
48     , m_isAttribute(isAttribute)
49     , m_isolatedWorld(&isolatedWorld)
50 {
51     if (wrapper) {
52         JSC::Heap::heap(wrapper)->writeBarrier(wrapper, function);
53         m_jsFunction = JSC::Weak<JSC::JSObject>(function);
54     } else
55         ASSERT(!function);
56 }
57
58 JSEventListener::~JSEventListener()
59 {
60 }
61
62 JSObject* JSEventListener::initializeJSFunction(ScriptExecutionContext*) const
63 {
64     return 0;
65 }
66
67 void JSEventListener::visitJSFunction(SlotVisitor& visitor)
68 {
69     // If m_wrapper is 0, then m_jsFunction is zombied, and should never be accessed.
70     if (!m_wrapper)
71         return;
72
73     visitor.append(m_jsFunction);
74 }
75
76 void JSEventListener::handleEvent(ScriptExecutionContext* scriptExecutionContext, Event* event)
77 {
78     ASSERT(scriptExecutionContext);
79     if (!scriptExecutionContext || scriptExecutionContext->isJSExecutionForbidden())
80         return;
81
82     VM& vm = scriptExecutionContext->vm();
83     JSLockHolder lock(vm);
84     auto scope = DECLARE_CATCH_SCOPE(vm);
85     // See https://dom.spec.whatwg.org/#dispatching-events spec on calling handleEvent.
86     // "If this throws an exception, report the exception." It should not propagate the
87     // exception.
88
89     JSObject* jsFunction = this->jsFunction(scriptExecutionContext);
90     if (!jsFunction)
91         return;
92
93     JSDOMGlobalObject* globalObject = toJSDOMGlobalObject(scriptExecutionContext, *m_isolatedWorld);
94     if (!globalObject)
95         return;
96
97     if (scriptExecutionContext->isDocument()) {
98         JSDOMWindow* window = jsCast<JSDOMWindow*>(globalObject);
99         if (!window->wrapped().isCurrentlyDisplayedInFrame())
100             return;
101         if (wasCreatedFromMarkup() && !scriptExecutionContext->contentSecurityPolicy()->allowInlineEventHandlers(sourceURL(), sourcePosition().m_line))
102             return;
103         // FIXME: Is this check needed for other contexts?
104         ScriptController& script = window->wrapped().frame()->script();
105         if (!script.canExecuteScripts(AboutToExecuteScript) || script.isPaused())
106             return;
107     }
108
109     ExecState* exec = globalObject->globalExec();
110     JSValue handleEventFunction = jsFunction;
111
112     CallData callData;
113     CallType callType = getCallData(handleEventFunction, callData);
114     // If jsFunction is not actually a function, see if it implements the EventListener interface and use that
115     if (callType == CallType::None) {
116         handleEventFunction = jsFunction->get(exec, Identifier::fromString(exec, "handleEvent"));
117         if (UNLIKELY(scope.exception())) {
118             auto* exception = scope.exception();
119             scope.clearException();
120
121             event->target()->uncaughtExceptionInEventHandler();
122             reportException(exec, exception);
123             return;
124         }
125         callType = getCallData(handleEventFunction, callData);
126     }
127
128     if (callType != CallType::None) {
129         Ref<JSEventListener> protectedThis(*this);
130
131         MarkedArgumentBuffer args;
132         args.append(toJS(exec, globalObject, event));
133
134         Event* savedEvent = globalObject->currentEvent();
135         globalObject->setCurrentEvent(event);
136
137         VMEntryScope entryScope(vm, vm.entryScope ? vm.entryScope->globalObject() : globalObject);
138
139         InspectorInstrumentationCookie cookie = JSMainThreadExecState::instrumentFunctionCall(scriptExecutionContext, callType, callData);
140
141         JSValue thisValue = handleEventFunction == jsFunction ? toJS(exec, globalObject, event->currentTarget()) : jsFunction;
142         NakedPtr<JSC::Exception> exception;
143         JSValue retval = scriptExecutionContext->isDocument()
144             ? JSMainThreadExecState::profiledCall(exec, JSC::ProfilingReason::Other, handleEventFunction, callType, callData, thisValue, args, exception)
145             : JSC::profiledCall(exec, JSC::ProfilingReason::Other, handleEventFunction, callType, callData, thisValue, args, exception);
146
147         InspectorInstrumentation::didCallFunction(cookie, scriptExecutionContext);
148
149         globalObject->setCurrentEvent(savedEvent);
150
151         if (is<WorkerGlobalScope>(*scriptExecutionContext)) {
152             auto scriptController = downcast<WorkerGlobalScope>(*scriptExecutionContext).script();
153             bool terminatorCausedException = (scope.exception() && isTerminatedExecutionException(vm, scope.exception()));
154             if (terminatorCausedException || scriptController->isTerminatingExecution())
155                 scriptController->forbidExecution();
156         }
157
158         if (exception) {
159             event->target()->uncaughtExceptionInEventHandler();
160             reportException(exec, exception);
161         } else {
162             if (!retval.isUndefinedOrNull() && is<BeforeUnloadEvent>(*event))
163                 downcast<BeforeUnloadEvent>(*event).setReturnValue(retval.toWTFString(exec));
164             if (m_isAttribute) {
165                 if (retval.isFalse())
166                     event->preventDefault();
167             }
168         }
169     }
170 }
171
172 bool JSEventListener::virtualisAttribute() const
173 {
174     return m_isAttribute;
175 }
176
177 bool JSEventListener::operator==(const EventListener& listener) const
178 {
179     if (const JSEventListener* jsEventListener = JSEventListener::cast(&listener))
180         return m_jsFunction == jsEventListener->m_jsFunction && m_isAttribute == jsEventListener->m_isAttribute;
181     return false;
182 }
183
184 static inline JSC::JSValue eventHandlerAttribute(EventListener* abstractListener, ScriptExecutionContext& context)
185 {
186     if (!abstractListener)
187         return jsNull();
188
189     auto* listener = JSEventListener::cast(abstractListener);
190     if (!listener)
191         return jsNull();
192
193     auto* function = listener->jsFunction(&context);
194     if (!function)
195         return jsNull();
196
197     return function;
198 }
199
200 static inline RefPtr<JSEventListener> createEventListenerForEventHandlerAttribute(JSC::ExecState& state, JSC::JSValue listener, JSC::JSObject& wrapper)
201 {
202     if (!listener.isObject())
203         return nullptr;
204     return JSEventListener::create(asObject(listener), &wrapper, true, currentWorld(&state));
205 }
206
207 JSC::JSValue eventHandlerAttribute(EventTarget& target, const AtomicString& eventType)
208 {
209     return eventHandlerAttribute(target.attributeEventListener(eventType), *target.scriptExecutionContext());
210 }
211
212 void setEventHandlerAttribute(JSC::ExecState& state, JSC::JSObject& wrapper, EventTarget& target, const AtomicString& eventType, JSC::JSValue value)
213 {
214     target.setAttributeEventListener(eventType, createEventListenerForEventHandlerAttribute(state, value, wrapper));
215 }
216
217 JSC::JSValue windowEventHandlerAttribute(HTMLElement& element, const AtomicString& eventType)
218 {
219     auto& document = element.document();
220     return eventHandlerAttribute(document.getWindowAttributeEventListener(eventType), document);
221 }
222
223 void setWindowEventHandlerAttribute(JSC::ExecState& state, JSC::JSObject& wrapper, HTMLElement& element, const AtomicString& eventType, JSC::JSValue value)
224 {
225     ASSERT(wrapper.globalObject());
226     element.document().setWindowAttributeEventListener(eventType, createEventListenerForEventHandlerAttribute(state, value, *wrapper.globalObject()));
227 }
228
229 JSC::JSValue windowEventHandlerAttribute(DOMWindow& window, const AtomicString& eventType)
230 {
231     return eventHandlerAttribute(window, eventType);
232 }
233
234 void setWindowEventHandlerAttribute(JSC::ExecState& state, JSC::JSObject& wrapper, DOMWindow& window, const AtomicString& eventType, JSC::JSValue value)
235 {
236     setEventHandlerAttribute(state, wrapper, window, eventType, value);
237 }
238
239 JSC::JSValue documentEventHandlerAttribute(HTMLElement& element, const AtomicString& eventType)
240 {
241     auto& document = element.document();
242     return eventHandlerAttribute(document.attributeEventListener(eventType), document);
243 }
244
245 void setDocumentEventHandlerAttribute(JSC::ExecState& state, JSC::JSObject& wrapper, HTMLElement& element, const AtomicString& eventType, JSC::JSValue value)
246 {
247     ASSERT(wrapper.globalObject());
248     auto& document = element.document();
249     auto* documentWrapper = JSC::jsCast<JSDocument*>(toJS(&state, JSC::jsCast<JSDOMGlobalObject*>(wrapper.globalObject()), document));
250     ASSERT(documentWrapper);
251     document.setAttributeEventListener(eventType, createEventListenerForEventHandlerAttribute(state, value, *documentWrapper));
252 }
253
254 JSC::JSValue documentEventHandlerAttribute(Document& document, const AtomicString& eventType)
255 {
256     return eventHandlerAttribute(document, eventType);
257 }
258
259 void setDocumentEventHandlerAttribute(JSC::ExecState& state, JSC::JSObject& wrapper, Document& document, const AtomicString& eventType, JSC::JSValue value)
260 {
261     setEventHandlerAttribute(state, wrapper, document, eventType, value);
262 }
263
264 } // namespace WebCore