58beb7f9aa46d6769629b64cbdecf449ea41841e
[WebKit-https.git] / Source / WebCore / dom / MessagePort.cpp
1 /*
2  * Copyright (C) 2008 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 #include "config.h"
28 #include "MessagePort.h"
29
30 #include "Document.h"
31 #include "EventException.h"
32 #include "MessageEvent.h"
33 #include "SecurityOrigin.h"
34 #include "WorkerGlobalScope.h"
35
36 namespace WebCore {
37
38 MessagePort::MessagePort(ScriptExecutionContext& scriptExecutionContext)
39     : m_started(false)
40     , m_closed(false)
41     , m_scriptExecutionContext(&scriptExecutionContext)
42 {
43     m_scriptExecutionContext->createdMessagePort(*this);
44
45     // Don't need to call processMessagePortMessagesSoon() here, because the port will not be opened until start() is invoked.
46 }
47
48 MessagePort::~MessagePort()
49 {
50     close();
51     if (m_scriptExecutionContext)
52         m_scriptExecutionContext->destroyedMessagePort(*this);
53 }
54
55 void MessagePort::postMessage(PassRefPtr<SerializedScriptValue> message, MessagePort* port, ExceptionCode& ec)
56 {
57     MessagePortArray ports;
58     if (port)
59         ports.append(port);
60     postMessage(message, &ports, ec);
61 }
62
63 void MessagePort::postMessage(PassRefPtr<SerializedScriptValue> message, const MessagePortArray* ports, ExceptionCode& ec)
64 {
65     if (!isEntangled())
66         return;
67     ASSERT(m_scriptExecutionContext);
68
69     std::unique_ptr<MessagePortChannelArray> channels;
70     // Make sure we aren't connected to any of the passed-in ports.
71     if (ports) {
72         for (unsigned int i = 0; i < ports->size(); ++i) {
73             MessagePort* dataPort = (*ports)[i].get();
74             if (dataPort == this || m_entangledChannel->isConnectedTo(dataPort)) {
75                 ec = DATA_CLONE_ERR;
76                 return;
77             }
78         }
79         channels = MessagePort::disentanglePorts(ports, ec);
80         if (ec)
81             return;
82     }
83     m_entangledChannel->postMessageToRemote(message, WTF::move(channels));
84 }
85
86 std::unique_ptr<MessagePortChannel> MessagePort::disentangle()
87 {
88     ASSERT(m_entangledChannel);
89
90     m_entangledChannel->disentangle();
91
92     // We can't receive any messages or generate any events after this, so remove ourselves from the list of active ports.
93     ASSERT(m_scriptExecutionContext);
94     m_scriptExecutionContext->destroyedMessagePort(*this);
95     m_scriptExecutionContext = nullptr;
96
97     return WTF::move(m_entangledChannel);
98 }
99
100 // Invoked to notify us that there are messages available for this port.
101 // This code may be called from another thread, and so should not call any non-threadsafe APIs (i.e. should not call into the entangled channel or access mutable variables).
102 void MessagePort::messageAvailable()
103 {
104     ASSERT(m_scriptExecutionContext);
105     m_scriptExecutionContext->processMessagePortMessagesSoon();
106 }
107
108 void MessagePort::start()
109 {
110     // Do nothing if we've been cloned or closed.
111     if (!isEntangled())
112         return;
113
114     ASSERT(m_scriptExecutionContext);
115     if (m_started)
116         return;
117
118     m_started = true;
119     m_scriptExecutionContext->processMessagePortMessagesSoon();
120 }
121
122 void MessagePort::close()
123 {
124     if (isEntangled())
125         m_entangledChannel->close();
126     m_closed = true;
127 }
128
129 void MessagePort::entangle(std::unique_ptr<MessagePortChannel> remote)
130 {
131     // Only invoked to set our initial entanglement.
132     ASSERT(!m_entangledChannel);
133     ASSERT(m_scriptExecutionContext);
134
135     // Don't entangle the ports if the channel is closed.
136     if (remote->entangleIfOpen(this))
137         m_entangledChannel = WTF::move(remote);
138 }
139
140 void MessagePort::contextDestroyed()
141 {
142     ASSERT(m_scriptExecutionContext);
143     // Must be closed before blowing away the cached context, to ensure that we get no more calls to messageAvailable().
144     // ScriptExecutionContext::closeMessagePorts() takes care of that.
145     ASSERT(m_closed);
146     m_scriptExecutionContext = 0;
147 }
148
149 void MessagePort::dispatchMessages()
150 {
151     // Messages for contexts that are not fully active get dispatched too, but JSAbstractEventListener::handleEvent() doesn't call handlers for these.
152     // The HTML5 spec specifies that any messages sent to a document that is not fully active should be dropped, so this behavior is OK.
153     ASSERT(started());
154
155     RefPtr<SerializedScriptValue> message;
156     std::unique_ptr<MessagePortChannelArray> channels;
157     while (m_entangledChannel && m_entangledChannel->tryGetMessageFromRemote(message, channels)) {
158
159         // close() in Worker onmessage handler should prevent next message from dispatching.
160         if (is<WorkerGlobalScope>(m_scriptExecutionContext) && downcast<WorkerGlobalScope>(*m_scriptExecutionContext).isClosing())
161             return;
162
163         std::unique_ptr<MessagePortArray> ports = MessagePort::entanglePorts(*m_scriptExecutionContext, WTF::move(channels));
164         RefPtr<Event> evt = MessageEvent::create(WTF::move(ports), message.release());
165
166         dispatchEvent(evt.release(), ASSERT_NO_EXCEPTION);
167     }
168 }
169
170 bool MessagePort::hasPendingActivity()
171 {
172     // The spec says that entangled message ports should always be treated as if they have a strong reference.
173     // We'll also stipulate that the queue needs to be open (if the app drops its reference to the port before start()-ing it, then it's not really entangled as it's unreachable).
174     if (m_started && m_entangledChannel && m_entangledChannel->hasPendingActivity())
175         return true;
176     if (isEntangled() && !locallyEntangledPort())
177         return true;
178     return false;
179 }
180
181 MessagePort* MessagePort::locallyEntangledPort()
182 {
183     return m_entangledChannel ? m_entangledChannel->locallyEntangledPort(m_scriptExecutionContext) : 0;
184 }
185
186 std::unique_ptr<MessagePortChannelArray> MessagePort::disentanglePorts(const MessagePortArray* ports, ExceptionCode& ec)
187 {
188     if (!ports || !ports->size())
189         return nullptr;
190
191     // HashSet used to efficiently check for duplicates in the passed-in array.
192     HashSet<MessagePort*> portSet;
193
194     // Walk the incoming array - if there are any duplicate ports, or null ports or cloned ports, throw an error (per section 8.3.3 of the HTML5 spec).
195     for (unsigned int i = 0; i < ports->size(); ++i) {
196         MessagePort* port = (*ports)[i].get();
197         if (!port || port->isNeutered() || portSet.contains(port)) {
198             ec = DATA_CLONE_ERR;
199             return nullptr;
200         }
201         portSet.add(port);
202     }
203
204     // Passed-in ports passed validity checks, so we can disentangle them.
205     auto portArray = std::make_unique<MessagePortChannelArray>(ports->size());
206     for (unsigned int i = 0 ; i < ports->size() ; ++i) {
207         std::unique_ptr<MessagePortChannel> channel = (*ports)[i]->disentangle();
208         (*portArray)[i] = WTF::move(channel);
209     }
210     return portArray;
211 }
212
213 std::unique_ptr<MessagePortArray> MessagePort::entanglePorts(ScriptExecutionContext& context, std::unique_ptr<MessagePortChannelArray> channels)
214 {
215     if (!channels || !channels->size())
216         return nullptr;
217
218     auto portArray = std::make_unique<MessagePortArray>(channels->size());
219     for (unsigned int i = 0; i < channels->size(); ++i) {
220         RefPtr<MessagePort> port = MessagePort::create(context);
221         port->entangle(WTF::move((*channels)[i]));
222         (*portArray)[i] = port.release();
223     }
224     return portArray;
225 }
226
227 } // namespace WebCore