2011-04-27 Adam Barth <abarth@webkit.org>
[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 COMPUTER, 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 COMPUTER, 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 "DOMWindow.h"
31 #include "Document.h"
32 #include "EventException.h"
33 #include "EventNames.h"
34 #include "MessageEvent.h"
35 #include "SecurityOrigin.h"
36 #include "Timer.h"
37 #include "WorkerContext.h"
38 #include <wtf/text/AtomicString.h>
39
40 namespace WebCore {
41
42 MessagePort::MessagePort(ScriptExecutionContext& scriptExecutionContext)
43     : m_started(false)
44     , m_closed(false)
45     , m_scriptExecutionContext(&scriptExecutionContext)
46 {
47     m_scriptExecutionContext->createdMessagePort(this);
48
49     // Don't need to call processMessagePortMessagesSoon() here, because the port will not be opened until start() is invoked.
50 }
51
52 MessagePort::~MessagePort()
53 {
54     close();
55     if (m_scriptExecutionContext)
56         m_scriptExecutionContext->destroyedMessagePort(this);
57 }
58
59 // FIXME: remove this when we update the ObjC bindings (bug #28774).
60 void MessagePort::postMessage(PassRefPtr<SerializedScriptValue> message, MessagePort* port, ExceptionCode& ec)
61 {
62     MessagePortArray ports;
63     if (port)
64         ports.append(port);
65     postMessage(message, &ports, ec);
66 }
67
68 void MessagePort::postMessage(PassRefPtr<SerializedScriptValue> message, ExceptionCode& ec)
69 {
70     postMessage(message, static_cast<MessagePortArray*>(0), ec);
71 }
72
73 void MessagePort::postMessage(PassRefPtr<SerializedScriptValue> message, const MessagePortArray* ports, ExceptionCode& ec)
74 {
75     if (!isEntangled())
76         return;
77     ASSERT(m_scriptExecutionContext);
78
79     OwnPtr<MessagePortChannelArray> channels;
80     // Make sure we aren't connected to any of the passed-in ports.
81     if (ports) {
82         for (unsigned int i = 0; i < ports->size(); ++i) {
83             MessagePort* dataPort = (*ports)[i].get();
84             if (dataPort == this || m_entangledChannel->isConnectedTo(dataPort)) {
85                 ec = INVALID_STATE_ERR;
86                 return;
87             }
88         }
89         channels = MessagePort::disentanglePorts(ports, ec);
90         if (ec)
91             return;
92     }
93     m_entangledChannel->postMessageToRemote(MessagePortChannel::EventData::create(message, channels.release()));
94 }
95
96 PassOwnPtr<MessagePortChannel> MessagePort::disentangle(ExceptionCode& ec)
97 {
98     if (!m_entangledChannel)
99         ec = INVALID_STATE_ERR;
100     else {
101         m_entangledChannel->disentangle();
102
103         // We can't receive any messages or generate any events, so remove ourselves from the list of active ports.
104         ASSERT(m_scriptExecutionContext);
105         m_scriptExecutionContext->destroyedMessagePort(this);
106         m_scriptExecutionContext = 0;
107     }
108     return m_entangledChannel.release();
109 }
110
111 // Invoked to notify us that there are messages available for this port.
112 // 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).
113 void MessagePort::messageAvailable()
114 {
115     ASSERT(m_scriptExecutionContext);
116     m_scriptExecutionContext->processMessagePortMessagesSoon();
117 }
118
119 void MessagePort::start()
120 {
121     // Do nothing if we've been cloned or closed.
122     if (!isEntangled())
123         return;
124
125     ASSERT(m_scriptExecutionContext);
126     if (m_started)
127         return;
128
129     m_started = true;
130     m_scriptExecutionContext->processMessagePortMessagesSoon();
131 }
132
133 void MessagePort::close()
134 {
135     m_closed = true;
136     if (!isEntangled())
137         return;
138     m_entangledChannel->close();
139 }
140
141 void MessagePort::entangle(PassOwnPtr<MessagePortChannel> remote)
142 {
143     // Only invoked to set our initial entanglement.
144     ASSERT(!m_entangledChannel);
145     ASSERT(m_scriptExecutionContext);
146
147     // Don't entangle the ports if the channel is closed.
148     if (remote->entangleIfOpen(this))
149         m_entangledChannel = remote;
150 }
151
152 void MessagePort::contextDestroyed()
153 {
154     ASSERT(m_scriptExecutionContext);
155     // Must be closed before blowing away the cached context, to ensure that we get no more calls to messageAvailable().
156     // ScriptExecutionContext::closeMessagePorts() takes care of that.
157     ASSERT(m_closed);
158     m_scriptExecutionContext = 0;
159 }
160
161 ScriptExecutionContext* MessagePort::scriptExecutionContext() const
162 {
163     return m_scriptExecutionContext;
164 }
165
166 void MessagePort::dispatchMessages()
167 {
168     // Messages for contexts that are not fully active get dispatched too, but JSAbstractEventListener::handleEvent() doesn't call handlers for these.
169     // The HTML5 spec specifies that any messages sent to a document that is not fully active should be dropped, so this behavior is OK.
170     ASSERT(started());
171
172     OwnPtr<MessagePortChannel::EventData> eventData;
173     while (m_entangledChannel && m_entangledChannel->tryGetMessageFromRemote(eventData)) {
174
175 #if ENABLE(WORKERS)
176         // close() in Worker onmessage handler should prevent next message from dispatching.
177         if (m_scriptExecutionContext->isWorkerContext() && static_cast<WorkerContext*>(m_scriptExecutionContext)->isClosing())
178             return;
179 #endif
180
181         OwnPtr<MessagePortArray> ports = MessagePort::entanglePorts(*m_scriptExecutionContext, eventData->channels());
182         RefPtr<Event> evt = MessageEvent::create(ports.release(), eventData->message());
183
184         ExceptionCode ec = 0;
185         dispatchEvent(evt.release(), ec);
186         ASSERT(!ec);
187     }
188 }
189
190 bool MessagePort::hasPendingActivity()
191 {
192     // The spec says that entangled message ports should always be treated as if they have a strong reference.
193     // 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).
194     if (m_started && m_entangledChannel && m_entangledChannel->hasPendingActivity())
195         return true;
196     if (isEntangled() && !locallyEntangledPort())
197         return true;
198     return false;
199 }
200
201 MessagePort* MessagePort::locallyEntangledPort()
202 {
203     return m_entangledChannel ? m_entangledChannel->locallyEntangledPort(m_scriptExecutionContext) : 0;
204 }
205
206 PassOwnPtr<MessagePortChannelArray> MessagePort::disentanglePorts(const MessagePortArray* ports, ExceptionCode& ec)
207 {
208     if (!ports || !ports->size())
209         return PassOwnPtr<MessagePortChannelArray>();
210
211     // HashSet used to efficiently check for duplicates in the passed-in array.
212     HashSet<MessagePort*> portSet;
213
214     // 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).
215     for (unsigned int i = 0; i < ports->size(); ++i) {
216         MessagePort* port = (*ports)[i].get();
217         if (!port || port->isCloned() || portSet.contains(port)) {
218             ec = INVALID_STATE_ERR;
219             return PassOwnPtr<MessagePortChannelArray>();
220         }
221         portSet.add(port);
222     }
223
224     // Passed-in ports passed validity checks, so we can disentangle them.
225     OwnPtr<MessagePortChannelArray> portArray = adoptPtr(new MessagePortChannelArray(ports->size()));
226     for (unsigned int i = 0 ; i < ports->size() ; ++i) {
227         OwnPtr<MessagePortChannel> channel = (*ports)[i]->disentangle(ec);
228         ASSERT(!ec); // Can't generate exception here if passed above checks.
229         (*portArray)[i] = channel.release();
230     }
231     return portArray.release();
232 }
233
234 PassOwnPtr<MessagePortArray> MessagePort::entanglePorts(ScriptExecutionContext& context, PassOwnPtr<MessagePortChannelArray> channels)
235 {
236     if (!channels || !channels->size())
237         return PassOwnPtr<MessagePortArray>();
238
239     OwnPtr<MessagePortArray> portArray = adoptPtr(new MessagePortArray(channels->size()));
240     for (unsigned int i = 0; i < channels->size(); ++i) {
241         RefPtr<MessagePort> port = MessagePort::create(context);
242         port->entangle((*channels)[i].release());
243         (*portArray)[i] = port.release();
244     }
245     return portArray.release();
246 }
247
248 EventTargetData* MessagePort::eventTargetData()
249 {
250     return &m_eventTargetData;
251 }
252
253 EventTargetData* MessagePort::ensureEventTargetData()
254 {
255     return &m_eventTargetData;
256 }
257
258 } // namespace WebCore