Move some more assorted classes from ExceptionCode to Exception
[WebKit.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 <memory>
36
37 namespace Inspector {
38 class ConsoleMessage;
39 }
40
41 namespace WebCore {
42
43 class ContentSecurityPolicyResponseHeaders;
44 class Crypto;
45 class ScheduledAction;
46 class WorkerLocation;
47 class WorkerNavigator;
48 class WorkerThread;
49
50 namespace IDBClient {
51 class IDBConnectionProxy;
52 }
53
54 class WorkerGlobalScope : public RefCounted<WorkerGlobalScope>, public Supplementable<WorkerGlobalScope>, public ScriptExecutionContext, public EventTargetWithInlineData, public Base64Utilities {
55 public:
56     virtual ~WorkerGlobalScope();
57
58     virtual bool isDedicatedWorkerGlobalScope() const { return false; }
59
60     const URL& url() const final { return m_url; }
61
62 #if ENABLE(INDEXED_DATABASE)
63     IDBClient::IDBConnectionProxy* idbConnectionProxy() final;
64     void stopIndexedDatabase();
65 #endif
66
67     WorkerScriptController* script() { return m_script.get(); }
68     void clearScript() { m_script = nullptr; }
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& userAgent, WorkerThread&, bool shouldBypassMainWorldContentSecurityPolicy, RefPtr<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
127 #if ENABLE(WEB_SOCKETS)
128     SocketProvider* socketProvider() final;
129 #endif
130
131     bool shouldBypassMainWorldContentSecurityPolicy() const final { return m_shouldBypassMainWorldContentSecurityPolicy; }
132     bool isJSExecutionForbidden() const final;
133     SecurityOrigin* topOrigin() const final { return m_topOrigin.get(); }
134
135 #if ENABLE(SUBTLE_CRYPTO)
136     // The following two functions are side effects of providing extra protection to serialized
137     // CryptoKey data that went through the structured clone algorithm to local storage such as
138     // IndexedDB. They don't provide any proctection against communications between mainThread
139     // and workerThreads. In fact, they cause extra expense as workerThreads cannot talk to clients
140     // to unwrap/wrap crypto keys. Hence, workerThreads must always ask mainThread to unwrap/wrap
141     // keys, which results in a second communication and plain keys being transferred between
142     // workerThreads and the mainThread.
143     bool wrapCryptoKey(const Vector<uint8_t>& key, Vector<uint8_t>& wrappedKey) final;
144     bool unwrapCryptoKey(const Vector<uint8_t>& wrappedKey, Vector<uint8_t>& key) final;
145 #endif
146
147     URL m_url;
148     String m_userAgent;
149
150     mutable RefPtr<WorkerLocation> m_location;
151     mutable RefPtr<WorkerNavigator> m_navigator;
152
153     std::unique_ptr<WorkerScriptController> m_script;
154     WorkerThread& m_thread;
155
156     bool m_closing { false };
157     bool m_shouldBypassMainWorldContentSecurityPolicy;
158
159     mutable WorkerEventQueue m_eventQueue;
160
161     RefPtr<SecurityOrigin> m_topOrigin;
162
163 #if ENABLE(INDEXED_DATABASE)
164     RefPtr<IDBClient::IDBConnectionProxy> m_connectionProxy;
165 #endif
166
167 #if ENABLE(WEB_SOCKETS)
168     RefPtr<SocketProvider> m_socketProvider;
169 #endif
170
171     mutable RefPtr<Crypto> m_crypto;
172 };
173
174 } // namespace WebCore
175
176 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::WorkerGlobalScope)
177     static bool isType(const WebCore::ScriptExecutionContext& context) { return context.isWorkerGlobalScope(); }
178 SPECIALIZE_TYPE_TRAITS_END()