Teach ScriptExecutionContexts about their SessionID.
[WebKit-https.git] / Source / WebCore / workers / WorkerGlobalScope.h
1 /*
2  * Copyright (C) 2008-2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26
27 #pragma once
28
29 #include "Base64Utilities.h"
30 #include "EventTarget.h"
31 #include "ScriptExecutionContext.h"
32 #include "SessionID.h"
33 #include "Supplementable.h"
34 #include "URL.h"
35 #include "WorkerEventQueue.h"
36 #include "WorkerScriptController.h"
37 #include <inspector/ConsoleMessage.h>
38 #include <memory>
39
40 namespace WebCore {
41
42 class ContentSecurityPolicyResponseHeaders;
43 class Crypto;
44 class Performance;
45 class ScheduledAction;
46 class WorkerInspectorController;
47 class WorkerLocation;
48 class WorkerNavigator;
49 class WorkerThread;
50
51 namespace IDBClient {
52 class IDBConnectionProxy;
53 }
54
55 class WorkerGlobalScope : public RefCounted<WorkerGlobalScope>, public Supplementable<WorkerGlobalScope>, public ScriptExecutionContext, public EventTargetWithInlineData, public Base64Utilities {
56 public:
57     virtual ~WorkerGlobalScope();
58
59     virtual bool isDedicatedWorkerGlobalScope() const { return false; }
60
61     const URL& url() const final { return m_url; }
62     String origin() const;
63
64 #if ENABLE(INDEXED_DATABASE)
65     IDBClient::IDBConnectionProxy* idbConnectionProxy() final;
66     void stopIndexedDatabase();
67 #endif
68
69     WorkerScriptController* script() { return m_script.get(); }
70     void clearScript() { m_script = nullptr; }
71
72     WorkerInspectorController& inspectorController() const { return *m_inspectorController; }
73
74     WorkerThread& thread() const { return m_thread; }
75
76     using ScriptExecutionContext::hasPendingActivity;
77
78     void postTask(Task&&) final; // Executes the task on context's thread asynchronously.
79
80     WorkerGlobalScope& self() { return *this; }
81     WorkerLocation& location() const;
82     void close();
83
84     virtual ExceptionOr<void> importScripts(const Vector<String>& urls);
85     WorkerNavigator& navigator();
86
87     ExceptionOr<int> setTimeout(JSC::ExecState&, std::unique_ptr<ScheduledAction>, int timeout, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
88     void clearTimeout(int timeoutId);
89     ExceptionOr<int> setInterval(JSC::ExecState&, std::unique_ptr<ScheduledAction>, int timeout, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
90     void clearInterval(int timeoutId);
91
92     bool isContextThread() const final;
93     bool isSecureContext() const final;
94
95     WorkerNavigator* optionalNavigator() const { return m_navigator.get(); }
96     WorkerLocation* optionalLocation() const { return m_location.get(); }
97
98     using RefCounted::ref;
99     using RefCounted::deref;
100
101     bool isClosing() { return m_closing; }
102
103     void addConsoleMessage(std::unique_ptr<Inspector::ConsoleMessage>&&) final;
104
105     Crypto& crypto();
106     Performance& performance() const;
107
108     void removeAllEventListeners() final;
109
110 protected:
111     WorkerGlobalScope(const URL&, const String& identifier, const String& userAgent, WorkerThread&, bool shouldBypassMainWorldContentSecurityPolicy, Ref<SecurityOrigin>&& topOrigin, MonotonicTime timeOrigin, IDBClient::IDBConnectionProxy*, SocketProvider*, SessionID);
112
113     void applyContentSecurityPolicyResponseHeaders(const ContentSecurityPolicyResponseHeaders&);
114
115 private:
116     void refScriptExecutionContext() final { ref(); }
117     void derefScriptExecutionContext() final { deref(); }
118
119     void refEventTarget() final { ref(); }
120     void derefEventTarget() final { deref(); }
121
122     void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&&) final;
123
124     // The following addMessage and addConsoleMessage functions are deprecated.
125     // Callers should try to create the ConsoleMessage themselves.
126     void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, RefPtr<Inspector::ScriptCallStack>&&, JSC::ExecState*, unsigned long requestIdentifier) final;
127     void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier) final;
128
129     bool isWorkerGlobalScope() const final { return true; }
130
131     ScriptExecutionContext* scriptExecutionContext() const final { return const_cast<WorkerGlobalScope*>(this); }
132     URL completeURL(const String&) const final;
133     SessionID sessionID() const final { return m_sessionID; }
134     String userAgent(const URL&) const final;
135     void disableEval(const String& errorMessage) final;
136     void disableWebAssembly(const String& errorMessage) final;
137     EventTarget* errorEventTarget() final;
138     WorkerEventQueue& eventQueue() const final;
139     String resourceRequestIdentifier() const final { return m_identifier; }
140     SocketProvider* socketProvider() final;
141
142     bool shouldBypassMainWorldContentSecurityPolicy() const final { return m_shouldBypassMainWorldContentSecurityPolicy; }
143     bool isJSExecutionForbidden() const final;
144     SecurityOrigin& topOrigin() const final { return m_topOrigin.get(); }
145
146 #if ENABLE(SUBTLE_CRYPTO)
147     // The following two functions are side effects of providing extra protection to serialized
148     // CryptoKey data that went through the structured clone algorithm to local storage such as
149     // IndexedDB. They don't provide any proctection against communications between mainThread
150     // and workerThreads. In fact, they cause extra expense as workerThreads cannot talk to clients
151     // to unwrap/wrap crypto keys. Hence, workerThreads must always ask mainThread to unwrap/wrap
152     // keys, which results in a second communication and plain keys being transferred between
153     // workerThreads and the mainThread.
154     bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) final;
155     bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) final;
156 #endif
157
158     URL m_url;
159     String m_identifier;
160     String m_userAgent;
161
162     mutable RefPtr<WorkerLocation> m_location;
163     mutable RefPtr<WorkerNavigator> m_navigator;
164
165     WorkerThread& m_thread;
166     std::unique_ptr<WorkerScriptController> m_script;
167     std::unique_ptr<WorkerInspectorController> m_inspectorController;
168
169     bool m_closing { false };
170     bool m_shouldBypassMainWorldContentSecurityPolicy;
171
172     mutable WorkerEventQueue m_eventQueue;
173
174     Ref<SecurityOrigin> m_topOrigin;
175
176 #if ENABLE(INDEXED_DATABASE)
177     RefPtr<IDBClient::IDBConnectionProxy> m_connectionProxy;
178 #endif
179
180     RefPtr<SocketProvider> m_socketProvider;
181
182     RefPtr<Performance> m_performance;
183     mutable RefPtr<Crypto> m_crypto;
184
185     SessionID m_sessionID;
186 };
187
188 } // namespace WebCore
189
190 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::WorkerGlobalScope)
191     static bool isType(const WebCore::ScriptExecutionContext& context) { return context.isWorkerGlobalScope(); }
192 SPECIALIZE_TYPE_TRAITS_END()