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