Modern IDB (Workers): Enable INDEXED_DATABASE_IN_WORKERS compile time flag, but disab...
[WebKit-https.git] / Source / WebCore / dom / ScriptExecutionContext.h
1 /*
2  * Copyright (C) 2008, 2009, 2010, 2011, 2013, 2014, 2015, 2016 Apple Inc. All Rights Reserved.
3  * Copyright (C) 2012 Google Inc. All Rights Reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  */
27
28 #pragma once
29
30 #include "ActiveDOMObject.h"
31 #include "DOMTimer.h"
32 #include "ResourceRequest.h"
33 #include "SecurityContext.h"
34 #include "Supplementable.h"
35 #include <runtime/ConsoleTypes.h>
36 #include <wtf/HashSet.h>
37
38 namespace JSC {
39 class ExecState;
40 class VM;
41 }
42
43 namespace Inspector {
44 class ScriptCallStack;
45 }
46
47 namespace WebCore {
48
49 class CachedScript;
50 class DatabaseContext;
51 class EventQueue;
52 class EventTarget;
53 class MessagePort;
54 class PublicURLManager;
55 class SecurityOrigin;
56 class URL;
57
58 class ScriptExecutionContext : public SecurityContext {
59 public:
60     ScriptExecutionContext();
61     virtual ~ScriptExecutionContext();
62
63     virtual bool isDocument() const { return false; }
64     virtual bool isWorkerGlobalScope() const { return false; }
65
66     virtual bool isContextThread() const { return true; }
67     virtual bool isJSExecutionForbidden() const = 0;
68
69     virtual const URL& url() const = 0;
70     virtual URL completeURL(const String& url) const = 0;
71
72     virtual String userAgent(const URL&) const = 0;
73
74     virtual void disableEval(const String& errorMessage) = 0;
75
76     bool sanitizeScriptError(String& errorMessage, int& lineNumber, int& columnNumber, String& sourceURL, CachedScript* = nullptr);
77     void reportException(const String& errorMessage, int lineNumber, int columnNumber, const String& sourceURL, RefPtr<Inspector::ScriptCallStack>&&, CachedScript* = nullptr);
78
79     void addConsoleMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0);
80     virtual void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier = 0) = 0;
81
82     virtual SecurityOrigin* topOrigin() const = 0;
83
84     virtual bool shouldBypassMainWorldContentSecurityPolicy() const { return false; }
85
86     PublicURLManager& publicURLManager();
87
88     // Active objects are not garbage collected even if inaccessible, e.g. because their activity may result in callbacks being invoked.
89     WEBCORE_EXPORT bool canSuspendActiveDOMObjectsForDocumentSuspension(Vector<ActiveDOMObject*>* unsuspendableObjects = nullptr);
90
91     // Active objects can be asked to suspend even if canSuspendActiveDOMObjectsForDocumentSuspension() returns 'false' -
92     // step-by-step JS debugging is one example.
93     virtual void suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension);
94     virtual void resumeActiveDOMObjects(ActiveDOMObject::ReasonForSuspension);
95     virtual void stopActiveDOMObjects();
96
97     bool activeDOMObjectsAreSuspended() const { return m_activeDOMObjectsAreSuspended; }
98     bool activeDOMObjectsAreStopped() const { return m_activeDOMObjectsAreStopped; }
99
100     // Called from the constructor and destructors of ActiveDOMObject.
101     void didCreateActiveDOMObject(ActiveDOMObject&);
102     void willDestroyActiveDOMObject(ActiveDOMObject&);
103
104     // Called after the construction of an ActiveDOMObject to synchronize suspend state.
105     void suspendActiveDOMObjectIfNeeded(ActiveDOMObject&);
106
107     void didCreateDestructionObserver(ContextDestructionObserver&);
108     void willDestroyDestructionObserver(ContextDestructionObserver&);
109
110     // MessagePort is conceptually a kind of ActiveDOMObject, but it needs to be tracked separately for message dispatch.
111     void processMessagePortMessagesSoon();
112     void dispatchMessagePortEvents();
113     void createdMessagePort(MessagePort&);
114     void destroyedMessagePort(MessagePort&);
115
116     virtual void didLoadResourceSynchronously(const ResourceRequest&);
117
118     void ref() { refScriptExecutionContext(); }
119     void deref() { derefScriptExecutionContext(); }
120
121     class Task {
122         WTF_MAKE_FAST_ALLOCATED;
123     public:
124         enum CleanupTaskTag { CleanupTask };
125
126         template<typename T, typename = typename std::enable_if<!std::is_base_of<Task, T>::value && std::is_convertible<T, std::function<void (ScriptExecutionContext&)>>::value>::type>
127         Task(T task)
128             : m_task(WTFMove(task))
129             , m_isCleanupTask(false)
130         {
131         }
132
133         Task(std::function<void()> task)
134             : m_task([task](ScriptExecutionContext&) { task(); })
135             , m_isCleanupTask(false)
136         {
137         }
138
139         template<typename T, typename = typename std::enable_if<std::is_convertible<T, std::function<void (ScriptExecutionContext&)>>::value>::type>
140         Task(CleanupTaskTag, T task)
141             : m_task(WTFMove(task))
142             , m_isCleanupTask(true)
143         {
144         }
145
146         Task(Task&& other)
147             : m_task(WTFMove(other.m_task))
148             , m_isCleanupTask(other.m_isCleanupTask)
149         {
150         }
151
152         void performTask(ScriptExecutionContext& context) { m_task(context); }
153         bool isCleanupTask() const { return m_isCleanupTask; }
154
155     protected:
156         std::function<void (ScriptExecutionContext&)> m_task;
157         bool m_isCleanupTask;
158     };
159
160     virtual void postTask(Task) = 0; // Executes the task on context's thread asynchronously.
161
162     // Gets the next id in a circular sequence from 1 to 2^31-1.
163     int circularSequentialID();
164
165     bool addTimeout(int timeoutId, PassRefPtr<DOMTimer> timer) { return m_timeouts.add(timeoutId, timer).isNewEntry; }
166     void removeTimeout(int timeoutId) { m_timeouts.remove(timeoutId); }
167     DOMTimer* findTimeout(int timeoutId) { return m_timeouts.get(timeoutId); }
168
169     WEBCORE_EXPORT JSC::VM& vm();
170
171     // Interval is in seconds.
172     void adjustMinimumTimerInterval(std::chrono::milliseconds oldMinimumTimerInterval);
173     virtual std::chrono::milliseconds minimumTimerInterval() const;
174
175     void didChangeTimerAlignmentInterval();
176     virtual std::chrono::milliseconds timerAlignmentInterval(bool hasReachedMaxNestingLevel) const;
177
178     virtual EventQueue& eventQueue() const = 0;
179
180     void setDatabaseContext(DatabaseContext*);
181
182 #if ENABLE(SUBTLE_CRYPTO)
183     virtual bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) = 0;
184     virtual bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) = 0;
185 #endif
186
187     int timerNestingLevel() const { return m_timerNestingLevel; }
188     void setTimerNestingLevel(int timerNestingLevel) { m_timerNestingLevel = timerNestingLevel; }
189
190     JSC::ExecState* execState();
191
192 protected:
193     class AddConsoleMessageTask : public Task {
194     public:
195         AddConsoleMessageTask(MessageSource source, MessageLevel level, const StringCapture& message)
196             : Task([source, level, message](ScriptExecutionContext& context) {
197                 context.addConsoleMessage(source, level, message.string());
198             })
199         {
200         }
201     };
202
203     ActiveDOMObject::ReasonForSuspension reasonForSuspendingActiveDOMObjects() const { return m_reasonForSuspendingActiveDOMObjects; }
204
205     bool hasPendingActivity() const;
206
207 private:
208     virtual void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, RefPtr<Inspector::ScriptCallStack>&&, JSC::ExecState* = nullptr, unsigned long requestIdentifier = 0) = 0;
209     virtual EventTarget* errorEventTarget() = 0;
210     virtual void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&&) = 0;
211     bool dispatchErrorEvent(const String& errorMessage, int lineNumber, int columnNumber, const String& sourceURL, CachedScript*);
212
213     virtual void refScriptExecutionContext() = 0;
214     virtual void derefScriptExecutionContext() = 0;
215
216     void checkConsistency() const;
217
218     HashSet<MessagePort*> m_messagePorts;
219     HashSet<ContextDestructionObserver*> m_destructionObservers;
220     HashSet<ActiveDOMObject*> m_activeDOMObjects;
221
222     int m_circularSequentialID;
223     HashMap<int, RefPtr<DOMTimer>> m_timeouts;
224
225     bool m_inDispatchErrorEvent;
226     struct PendingException;
227     std::unique_ptr<Vector<std::unique_ptr<PendingException>>> m_pendingExceptions;
228
229     bool m_activeDOMObjectsAreSuspended;
230     ActiveDOMObject::ReasonForSuspension m_reasonForSuspendingActiveDOMObjects;
231     bool m_activeDOMObjectsAreStopped;
232
233     std::unique_ptr<PublicURLManager> m_publicURLManager;
234
235     RefPtr<DatabaseContext> m_databaseContext;
236
237     bool m_activeDOMObjectAdditionForbidden;
238     int m_timerNestingLevel;
239
240 #if !ASSERT_DISABLED
241     bool m_inScriptExecutionContextDestructor;
242 #endif
243 #if !ASSERT_DISABLED || ENABLE(SECURITY_ASSERTIONS)
244     bool m_activeDOMObjectRemovalForbidden;
245 #endif
246 };
247
248 } // namespace WebCore