45e4fe7a431db14312e32614dc8a989126b8a304
[WebKit-https.git] / Source / WebCore / workers / WorkerGlobalScope.h
1 /*
2  * Copyright (C) 2008-2016 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 "URL.h"
33 #include "WorkerEventQueue.h"
34 #include "WorkerScriptController.h"
35 #include <inspector/ConsoleMessage.h>
36 #include <memory>
37
38 namespace WebCore {
39
40 class ContentSecurityPolicyResponseHeaders;
41 class Crypto;
42 class ScheduledAction;
43 class WorkerInspectorController;
44 class WorkerLocation;
45 class WorkerNavigator;
46 class WorkerThread;
47
48 namespace IDBClient {
49 class IDBConnectionProxy;
50 }
51
52 class WorkerGlobalScope : public RefCounted<WorkerGlobalScope>, public Supplementable<WorkerGlobalScope>, public ScriptExecutionContext, public EventTargetWithInlineData, public Base64Utilities {
53 public:
54     virtual ~WorkerGlobalScope();
55
56     virtual bool isDedicatedWorkerGlobalScope() const { return false; }
57
58     const URL& url() const final { return m_url; }
59
60 #if ENABLE(INDEXED_DATABASE)
61     IDBClient::IDBConnectionProxy* idbConnectionProxy() final;
62     void stopIndexedDatabase();
63 #endif
64
65     WorkerScriptController* script() { return m_script.get(); }
66     void clearScript() { m_script = nullptr; }
67
68     WorkerInspectorController& inspectorController() const { return *m_inspectorController; }
69
70     WorkerThread& thread() const { return m_thread; }
71
72     using ScriptExecutionContext::hasPendingActivity;
73
74     void postTask(Task&&) final; // Executes the task on context's thread asynchronously.
75
76     WorkerGlobalScope& self() { return *this; }
77     WorkerLocation& location() const;
78     void close();
79
80     virtual ExceptionOr<void> importScripts(const Vector<String>& urls);
81     WorkerNavigator& navigator() const;
82
83     int setTimeout(std::unique_ptr<ScheduledAction>, int timeout);
84     void clearTimeout(int timeoutId);
85     int setInterval(std::unique_ptr<ScheduledAction>, int timeout);
86     void clearInterval(int timeoutId);
87
88     bool isContextThread() const final;
89
90     WorkerNavigator* optionalNavigator() const { return m_navigator.get(); }
91     WorkerLocation* optionalLocation() const { return m_location.get(); }
92
93     using RefCounted::ref;
94     using RefCounted::deref;
95
96     bool isClosing() { return m_closing; }
97
98     void addConsoleMessage(std::unique_ptr<Inspector::ConsoleMessage>&&);
99
100     Crypto& crypto();
101
102 protected:
103     WorkerGlobalScope(const URL&, const String& identifier, const String& userAgent, WorkerThread&, bool shouldBypassMainWorldContentSecurityPolicy, Ref<SecurityOrigin>&& topOrigin, IDBClient::IDBConnectionProxy*, SocketProvider*);
104
105     void applyContentSecurityPolicyResponseHeaders(const ContentSecurityPolicyResponseHeaders&);
106
107 private:
108     void refScriptExecutionContext() final { ref(); }
109     void derefScriptExecutionContext() final { deref(); }
110
111     void refEventTarget() final { ref(); }
112     void derefEventTarget() final { deref(); }
113
114     void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&&) final;
115     void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, RefPtr<Inspector::ScriptCallStack>&&, JSC::ExecState*, unsigned long requestIdentifier) final;
116     void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier) final;
117
118     bool isWorkerGlobalScope() const final { return true; }
119
120     ScriptExecutionContext* scriptExecutionContext() const final { return const_cast<WorkerGlobalScope*>(this); }
121     URL completeURL(const String&) const final;
122     String userAgent(const URL&) const final;
123     void disableEval(const String& errorMessage) final;
124     EventTarget* errorEventTarget() final;
125     WorkerEventQueue& eventQueue() const final;
126     String resourceRequestIdentifier() const final { return m_identifier; }
127
128 #if ENABLE(WEB_SOCKETS)
129     SocketProvider* socketProvider() final;
130 #endif
131
132     bool shouldBypassMainWorldContentSecurityPolicy() const final { return m_shouldBypassMainWorldContentSecurityPolicy; }
133     bool isJSExecutionForbidden() const final;
134     SecurityOrigin& topOrigin() const final { return m_topOrigin.get(); }
135
136 #if ENABLE(SUBTLE_CRYPTO)
137     // The following two functions are side effects of providing extra protection to serialized
138     // CryptoKey data that went through the structured clone algorithm to local storage such as
139     // IndexedDB. They don't provide any proctection against communications between mainThread
140     // and workerThreads. In fact, they cause extra expense as workerThreads cannot talk to clients
141     // to unwrap/wrap crypto keys. Hence, workerThreads must always ask mainThread to unwrap/wrap
142     // keys, which results in a second communication and plain keys being transferred between
143     // workerThreads and the mainThread.
144     bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) final;
145     bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) final;
146 #endif
147
148     URL m_url;
149     String m_identifier;
150     String m_userAgent;
151
152     mutable RefPtr<WorkerLocation> m_location;
153     mutable RefPtr<WorkerNavigator> m_navigator;
154
155     WorkerThread& m_thread;
156     std::unique_ptr<WorkerScriptController> m_script;
157     std::unique_ptr<WorkerInspectorController> m_inspectorController;
158
159     bool m_closing { false };
160     bool m_shouldBypassMainWorldContentSecurityPolicy;
161
162     mutable WorkerEventQueue m_eventQueue;
163
164     Ref<SecurityOrigin> m_topOrigin;
165
166 #if ENABLE(INDEXED_DATABASE)
167     RefPtr<IDBClient::IDBConnectionProxy> m_connectionProxy;
168 #endif
169
170 #if ENABLE(WEB_SOCKETS)
171     RefPtr<SocketProvider> m_socketProvider;
172 #endif
173
174     mutable RefPtr<Crypto> m_crypto;
175 };
176
177 } // namespace WebCore
178
179 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::WorkerGlobalScope)
180     static bool isType(const WebCore::ScriptExecutionContext& context) { return context.isWorkerGlobalScope(); }
181 SPECIALIZE_TYPE_TRAITS_END()