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