Move URL from WebCore to WTF
[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 "CacheStorageConnection.h"
31 #include "EventTarget.h"
32 #include "ImageBitmap.h"
33 #include "ScriptExecutionContext.h"
34 #include "Supplementable.h"
35 #include <wtf/URL.h>
36 #include "WorkerCacheStorageConnection.h"
37 #include "WorkerEventQueue.h"
38 #include "WorkerScriptController.h"
39 #include <JavaScriptCore/ConsoleMessage.h>
40 #include <memory>
41 #include <pal/SessionID.h>
42
43 namespace WebCore {
44
45 class ContentSecurityPolicyResponseHeaders;
46 class Crypto;
47 class MicrotaskQueue;
48 class Performance;
49 class ScheduledAction;
50 class WorkerInspectorController;
51 class WorkerLocation;
52 class WorkerNavigator;
53 class WorkerThread;
54
55 namespace IDBClient {
56 class IDBConnectionProxy;
57 }
58
59 class WorkerGlobalScope : public RefCounted<WorkerGlobalScope>, public Supplementable<WorkerGlobalScope>, public ScriptExecutionContext, public EventTargetWithInlineData, public Base64Utilities {
60 public:
61     virtual ~WorkerGlobalScope();
62
63     virtual bool isDedicatedWorkerGlobalScope() const { return false; }
64     virtual bool isServiceWorkerGlobalScope() const { return false; }
65
66     const URL& url() const final { return m_url; }
67     String origin() const final;
68     const String& identifier() const { return m_identifier; }
69
70 #if ENABLE(INDEXED_DATABASE)
71     IDBClient::IDBConnectionProxy* idbConnectionProxy() final;
72 #endif
73
74     WorkerCacheStorageConnection& cacheStorageConnection();
75
76     WorkerScriptController* script() { return m_script.get(); }
77     void clearScript() { m_script = nullptr; }
78
79     WorkerInspectorController& inspectorController() const { return *m_inspectorController; }
80
81     MicrotaskQueue& microtaskQueue() const { return *m_microtaskQueue; }
82
83     WorkerThread& thread() const { return m_thread; }
84
85     using ScriptExecutionContext::hasPendingActivity;
86
87     void postTask(Task&&) final; // Executes the task on context's thread asynchronously.
88
89     WorkerGlobalScope& self() { return *this; }
90     WorkerLocation& location() const;
91     void close();
92
93     virtual ExceptionOr<void> importScripts(const Vector<String>& urls);
94     WorkerNavigator& navigator();
95
96     void setIsOnline(bool);
97
98     ExceptionOr<int> setTimeout(JSC::ExecState&, std::unique_ptr<ScheduledAction>, int timeout, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
99     void clearTimeout(int timeoutId);
100     ExceptionOr<int> setInterval(JSC::ExecState&, std::unique_ptr<ScheduledAction>, int timeout, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
101     void clearInterval(int timeoutId);
102
103     bool isContextThread() const final;
104     bool isSecureContext() const final;
105
106     WorkerNavigator* optionalNavigator() const { return m_navigator.get(); }
107     WorkerLocation* optionalLocation() const { return m_location.get(); }
108
109     using RefCounted::ref;
110     using RefCounted::deref;
111
112     bool isClosing() { return m_closing; }
113
114     void addConsoleMessage(std::unique_ptr<Inspector::ConsoleMessage>&&) final;
115
116     Crypto& crypto();
117     Performance& performance() const;
118
119     void prepareForTermination();
120
121     void removeAllEventListeners() final;
122
123     void createImageBitmap(ImageBitmap::Source&&, ImageBitmapOptions&&, ImageBitmap::Promise&&);
124     void createImageBitmap(ImageBitmap::Source&&, int sx, int sy, int sw, int sh, ImageBitmapOptions&&, ImageBitmap::Promise&&);
125
126     unsigned long createUniqueIdentifier() { return m_uniqueIdentifier++; }
127
128 protected:
129     WorkerGlobalScope(const URL&, Ref<SecurityOrigin>&&, const String& identifier, const String& userAgent, bool isOnline, WorkerThread&, bool shouldBypassMainWorldContentSecurityPolicy, Ref<SecurityOrigin>&& topOrigin, MonotonicTime timeOrigin, IDBClient::IDBConnectionProxy*, SocketProvider*, PAL::SessionID);
130
131     void applyContentSecurityPolicyResponseHeaders(const ContentSecurityPolicyResponseHeaders&);
132
133 private:
134     void refScriptExecutionContext() final { ref(); }
135     void derefScriptExecutionContext() final { deref(); }
136
137     void refEventTarget() final { ref(); }
138     void derefEventTarget() final { deref(); }
139
140     void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, int columnNumber, RefPtr<Inspector::ScriptCallStack>&&) final;
141
142     // The following addMessage and addConsoleMessage functions are deprecated.
143     // Callers should try to create the ConsoleMessage themselves.
144     void addMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, unsigned columnNumber, RefPtr<Inspector::ScriptCallStack>&&, JSC::ExecState*, unsigned long requestIdentifier) final;
145     void addConsoleMessage(MessageSource, MessageLevel, const String& message, unsigned long requestIdentifier) final;
146
147     bool isWorkerGlobalScope() const final { return true; }
148
149     ScriptExecutionContext* scriptExecutionContext() const final { return const_cast<WorkerGlobalScope*>(this); }
150     URL completeURL(const String&) const final;
151     PAL::SessionID sessionID() const final { return m_sessionID; }
152     String userAgent(const URL&) const final;
153     void disableEval(const String& errorMessage) final;
154     void disableWebAssembly(const String& errorMessage) final;
155     EventTarget* errorEventTarget() final;
156     WorkerEventQueue& eventQueue() const final;
157     String resourceRequestIdentifier() const final { return m_identifier; }
158     SocketProvider* socketProvider() final;
159
160     bool shouldBypassMainWorldContentSecurityPolicy() const final { return m_shouldBypassMainWorldContentSecurityPolicy; }
161     bool isJSExecutionForbidden() const final;
162     SecurityOrigin& topOrigin() const final { return m_topOrigin.get(); }
163
164 #if ENABLE(WEB_CRYPTO)
165     // The following two functions are side effects of providing extra protection to serialized
166     // CryptoKey data that went through the structured clone algorithm to local storage such as
167     // IndexedDB. They don't provide any proctection against communications between mainThread
168     // and workerThreads. In fact, they cause extra expense as workerThreads cannot talk to clients
169     // to unwrap/wrap crypto keys. Hence, workerThreads must always ask mainThread to unwrap/wrap
170     // keys, which results in a second communication and plain keys being transferred between
171     // workerThreads and the mainThread.
172     bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) final;
173     bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) final;
174 #endif
175
176 #if ENABLE(INDEXED_DATABASE)
177     void stopIndexedDatabase();
178 #endif
179
180     URL m_url;
181     String m_identifier;
182     String m_userAgent;
183
184     mutable RefPtr<WorkerLocation> m_location;
185     mutable RefPtr<WorkerNavigator> m_navigator;
186
187     WorkerThread& m_thread;
188     std::unique_ptr<WorkerScriptController> m_script;
189     std::unique_ptr<WorkerInspectorController> m_inspectorController;
190     std::unique_ptr<MicrotaskQueue> m_microtaskQueue;
191
192     bool m_closing { false };
193     bool m_isOnline;
194     bool m_shouldBypassMainWorldContentSecurityPolicy;
195
196     mutable WorkerEventQueue m_eventQueue;
197
198     Ref<SecurityOrigin> m_topOrigin;
199
200 #if ENABLE(INDEXED_DATABASE)
201     RefPtr<IDBClient::IDBConnectionProxy> m_connectionProxy;
202 #endif
203
204     RefPtr<SocketProvider> m_socketProvider;
205
206     RefPtr<Performance> m_performance;
207     mutable RefPtr<Crypto> m_crypto;
208
209     PAL::SessionID m_sessionID;
210     RefPtr<WorkerCacheStorageConnection> m_cacheStorageConnection;
211
212     unsigned long m_uniqueIdentifier { 1 };
213 };
214
215 } // namespace WebCore
216
217 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::WorkerGlobalScope)
218     static bool isType(const WebCore::ScriptExecutionContext& context) { return context.isWorkerGlobalScope(); }
219 SPECIALIZE_TYPE_TRAITS_END()