Replace WTF::move with WTFMove
[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 "ExceptionCode.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 (auto& dataPort : *ports) {
73             if (dataPort == this || m_entangledChannel->isConnectedTo(dataPort.get())) {
74                 ec = DATA_CLONE_ERR;
75                 return;
76             }
77         }
78         channels = MessagePort::disentanglePorts(ports, ec);
79         if (ec)
80             return;
81     }
82     m_entangledChannel->postMessageToRemote(message, WTFMove(channels));
83 }
84
85 std::unique_ptr<MessagePortChannel> MessagePort::disentangle()
86 {
87     ASSERT(m_entangledChannel);
88
89     m_entangledChannel->disentangle();
90
91     // We can't receive any messages or generate any events after this, so remove ourselves from the list of active ports.
92     ASSERT(m_scriptExecutionContext);
93     m_scriptExecutionContext->destroyedMessagePort(*this);
94     m_scriptExecutionContext = nullptr;
95
96     return WTFMove(m_entangledChannel);
97 }
98
99 // Invoked to notify us that there are messages available for this port.
100 // 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).
101 void MessagePort::messageAvailable()
102 {
103     ASSERT(m_scriptExecutionContext);
104     m_scriptExecutionContext->processMessagePortMessagesSoon();
105 }
106
107 void MessagePort::start()
108 {
109     // Do nothing if we've been cloned or closed.
110     if (!isEntangled())
111         return;
112
113     ASSERT(m_scriptExecutionContext);
114     if (m_started)
115         return;
116
117     m_started = true;
118     m_scriptExecutionContext->processMessagePortMessagesSoon();
119 }
120
121 void MessagePort::close()
122 {
123     if (isEntangled())
124         m_entangledChannel->close();
125     m_closed = true;
126 }
127
128 void MessagePort::entangle(std::unique_ptr<MessagePortChannel> remote)
129 {
130     // Only invoked to set our initial entanglement.
131     ASSERT(!m_entangledChannel);
132     ASSERT(m_scriptExecutionContext);
133
134     // Don't entangle the ports if the channel is closed.
135     if (remote->entangleIfOpen(this))
136         m_entangledChannel = WTFMove(remote);
137 }
138
139 void MessagePort::contextDestroyed()
140 {
141     ASSERT(m_scriptExecutionContext);
142     // Must be closed before blowing away the cached context, to ensure that we get no more calls to messageAvailable().
143     // ScriptExecutionContext::closeMessagePorts() takes care of that.
144     ASSERT(m_closed);
145     m_scriptExecutionContext = nullptr;
146 }
147
148 void MessagePort::dispatchMessages()
149 {
150     // Messages for contexts that are not fully active get dispatched too, but JSAbstractEventListener::handleEvent() doesn't call handlers for these.
151     // The HTML5 spec specifies that any messages sent to a document that is not fully active should be dropped, so this behavior is OK.
152     ASSERT(started());
153
154     RefPtr<SerializedScriptValue> message;
155     std::unique_ptr<MessagePortChannelArray> channels;
156     while (m_entangledChannel && m_entangledChannel->tryGetMessageFromRemote(message, channels)) {
157
158         // close() in Worker onmessage handler should prevent next message from dispatching.
159         if (is<WorkerGlobalScope>(*m_scriptExecutionContext) && downcast<WorkerGlobalScope>(*m_scriptExecutionContext).isClosing())
160             return;
161
162         std::unique_ptr<MessagePortArray> ports = MessagePort::entanglePorts(*m_scriptExecutionContext, WTFMove(channels));
163         Ref<Event> event = MessageEvent::create(WTFMove(ports), message.release());
164         dispatchEvent(event);
165     }
166 }
167
168 bool MessagePort::hasPendingActivity()
169 {
170     // The spec says that entangled message ports should always be treated as if they have a strong reference.
171     // 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).
172     if (m_started && m_entangledChannel && m_entangledChannel->hasPendingActivity())
173         return true;
174     if (isEntangled() && !locallyEntangledPort())
175         return true;
176     return false;
177 }
178
179 MessagePort* MessagePort::locallyEntangledPort()
180 {
181     return m_entangledChannel ? m_entangledChannel->locallyEntangledPort(m_scriptExecutionContext) : nullptr;
182 }
183
184 std::unique_ptr<MessagePortChannelArray> MessagePort::disentanglePorts(const MessagePortArray* ports, ExceptionCode& ec)
185 {
186     if (!ports || !ports->size())
187         return nullptr;
188
189     // HashSet used to efficiently check for duplicates in the passed-in array.
190     HashSet<MessagePort*> portSet;
191
192     // 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).
193     for (auto& port : *ports) {
194         if (!port || port->isNeutered() || portSet.contains(port.get())) {
195             ec = DATA_CLONE_ERR;
196             return nullptr;
197         }
198         portSet.add(port.get());
199     }
200
201     // Passed-in ports passed validity checks, so we can disentangle them.
202     auto portArray = std::make_unique<MessagePortChannelArray>(ports->size());
203     for (unsigned int i = 0 ; i < ports->size() ; ++i) {
204         std::unique_ptr<MessagePortChannel> channel = (*ports)[i]->disentangle();
205         (*portArray)[i] = WTFMove(channel);
206     }
207     return portArray;
208 }
209
210 std::unique_ptr<MessagePortArray> MessagePort::entanglePorts(ScriptExecutionContext& context, std::unique_ptr<MessagePortChannelArray> channels)
211 {
212     if (!channels || !channels->size())
213         return nullptr;
214
215     auto portArray = std::make_unique<MessagePortArray>(channels->size());
216     for (unsigned int i = 0; i < channels->size(); ++i) {
217         RefPtr<MessagePort> port = MessagePort::create(context);
218         port->entangle(WTFMove((*channels)[i]));
219         (*portArray)[i] = port.release();
220     }
221     return portArray;
222 }
223
224 bool MessagePort::addEventListener(const AtomicString& eventType, RefPtr<EventListener>&& listener, bool useCapture)
225 {
226     if (listener && listener->isAttribute() && eventType == eventNames().messageEvent)
227         start();
228     return EventTargetWithInlineData::addEventListener(eventType, WTFMove(listener), useCapture);
229 }
230
231 } // namespace WebCore