38629d74925fdf822d08162cbafa229e1cbd0d33
[WebKit-https.git] / WebCore / websockets / WebSocket.cpp
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #include "config.h"
32
33 #if ENABLE(WEB_SOCKETS)
34
35 #include "WebSocket.h"
36
37 #include "DOMWindow.h"
38 #include "Event.h"
39 #include "EventException.h"
40 #include "EventListener.h"
41 #include "EventNames.h"
42 #include "Logging.h"
43 #include "MessageEvent.h"
44 #include "ScriptExecutionContext.h"
45 #include "StringBuilder.h"
46 #include "ThreadableWebSocketChannel.h"
47 #include "WebSocketChannel.h"
48 #include <wtf/text/CString.h>
49 #include <wtf/StdLibExtras.h>
50
51 namespace WebCore {
52
53 static bool isValidProtocolString(const String& protocol)
54 {
55     if (protocol.isNull())
56         return true;
57     if (protocol.isEmpty())
58         return false;
59     const UChar* characters = protocol.characters();
60     for (size_t i = 0; i < protocol.length(); i++) {
61         if (characters[i] < 0x20 || characters[i] > 0x7E)
62             return false;
63     }
64     return true;
65 }
66
67 static String encodeProtocolString(const String& protocol)
68 {
69     StringBuilder builder;
70     for (size_t i = 0; i < protocol.length(); i++) {
71         if (protocol[i] < 0x20 || protocol[i] > 0x7E)
72             builder.append(String::format("\\u%04X", protocol[i]));
73         else if (protocol[i] == 0x5c)
74             builder.append("\\\\");
75         else
76             builder.append(protocol[i]);
77     }
78     return builder.toString();
79 }
80
81 static bool webSocketsAvailable = false;
82
83 void WebSocket::setIsAvailable(bool available)
84 {
85     webSocketsAvailable = available;
86 }
87
88 bool WebSocket::isAvailable()
89 {
90     return webSocketsAvailable;
91 }
92
93 WebSocket::WebSocket(ScriptExecutionContext* context)
94     : ActiveDOMObject(context, this)
95     , m_state(CONNECTING)
96     , m_bufferedAmountAfterClose(0)
97 {
98 }
99
100 WebSocket::~WebSocket()
101 {
102     if (m_channel)
103         m_channel->disconnect();
104 }
105
106 void WebSocket::connect(const KURL& url, ExceptionCode& ec)
107 {
108     connect(url, String(), ec);
109 }
110
111 void WebSocket::connect(const KURL& url, const String& protocol, ExceptionCode& ec)
112 {
113     LOG(Network, "WebSocket %p connect to %s protocol=%s", this, url.string().utf8().data(), protocol.utf8().data());
114     m_url = url;
115     m_protocol = protocol;
116
117     if (!m_url.isValid()) {
118         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Invalid url for WebSocket " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
119         m_state = CLOSED;
120         ec = SYNTAX_ERR;
121         return;
122     }
123
124     if (!m_url.protocolIs("ws") && !m_url.protocolIs("wss")) {
125         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong url scheme for WebSocket " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
126         m_state = CLOSED;
127         ec = SYNTAX_ERR;
128         return;
129     }
130     if (m_url.hasFragmentIdentifier()) {
131         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "URL has fragment component " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
132         m_state = CLOSED;
133         ec = SYNTAX_ERR;
134         return;
135     }
136     if (!isValidProtocolString(m_protocol)) {
137         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(m_protocol) + "'", 0, scriptExecutionContext()->securityOrigin()->toString());
138         m_state = CLOSED;
139         ec = SYNTAX_ERR;
140         return;
141     }
142     if (!portAllowed(url)) {
143         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, String::format("WebSocket port %d blocked", url.port()), 0, scriptExecutionContext()->securityOrigin()->toString());
144         m_state = CLOSED;
145         ec = SECURITY_ERR;
146         return;
147     }
148
149     m_channel = ThreadableWebSocketChannel::create(scriptExecutionContext(), this, m_url, m_protocol);
150     m_channel->connect();
151     ActiveDOMObject::setPendingActivity(this);
152 }
153
154 bool WebSocket::send(const String& message, ExceptionCode& ec)
155 {
156     LOG(Network, "WebSocket %p send %s", this, message.utf8().data());
157     if (m_state == CONNECTING) {
158         ec = INVALID_STATE_ERR;
159         return false;
160     }
161     // No exception is raised if the connection was once established but has subsequently been closed.
162     if (m_state == CLOSED) {
163         m_bufferedAmountAfterClose += message.utf8().length() + 2; // 2 for frameing
164         return false;
165     }
166     // FIXME: check message is valid utf8.
167     ASSERT(m_channel);
168     return m_channel->send(message);
169 }
170
171 void WebSocket::close()
172 {
173     LOG(Network, "WebSocket %p close", this);
174     if (m_state == CLOSED)
175         return;
176     m_state = CLOSED;
177     m_bufferedAmountAfterClose = m_channel->bufferedAmount();
178     // didClose notification may be already queued, which we will inadvertently process while waiting for bufferedAmount() to return.
179     // In this case m_channel will be set to null during didClose() call, thus we need to test validness of m_channel here.
180     if (m_channel)
181         m_channel->close();
182 }
183
184 const KURL& WebSocket::url() const
185 {
186     return m_url;
187 }
188
189 WebSocket::State WebSocket::readyState() const
190 {
191     return m_state;
192 }
193
194 unsigned long WebSocket::bufferedAmount() const
195 {
196     if (m_state == OPEN)
197         return m_channel->bufferedAmount();
198     return m_bufferedAmountAfterClose;
199 }
200
201 ScriptExecutionContext* WebSocket::scriptExecutionContext() const
202 {
203     return ActiveDOMObject::scriptExecutionContext();
204 }
205
206 void WebSocket::contextDestroyed()
207 {
208     LOG(Network, "WebSocket %p scriptExecutionContext destroyed", this);
209     ASSERT(!m_channel);
210     ASSERT(m_state == CLOSED);
211     ActiveDOMObject::contextDestroyed();
212 }
213
214 bool WebSocket::canSuspend() const
215 {
216     return !m_channel;
217 }
218
219 void WebSocket::suspend()
220 {
221     if (m_channel)
222         m_channel->suspend();
223 }
224
225 void WebSocket::resume()
226 {
227     if (m_channel)
228         m_channel->resume();
229 }
230
231 void WebSocket::stop()
232 {
233     bool pending = hasPendingActivity();
234     if (m_channel)
235         m_channel->disconnect();
236     m_channel = 0;
237     m_state = CLOSED;
238     ActiveDOMObject::stop();
239     if (pending)
240         ActiveDOMObject::unsetPendingActivity(this);
241 }
242
243 void WebSocket::didConnect()
244 {
245     LOG(Network, "WebSocket %p didConnect", this);
246     if (m_state != CONNECTING) {
247         didClose(0);
248         return;
249     }
250     ASSERT(scriptExecutionContext());
251     m_state = OPEN;
252     dispatchEvent(Event::create(eventNames().openEvent, false, false));
253 }
254
255 void WebSocket::didReceiveMessage(const String& msg)
256 {
257     LOG(Network, "WebSocket %p didReceiveMessage %s", this, msg.utf8().data());
258     if (m_state != OPEN)
259         return;
260     ASSERT(scriptExecutionContext());
261     RefPtr<MessageEvent> evt = MessageEvent::create();
262     evt->initMessageEvent(eventNames().messageEvent, false, false, SerializedScriptValue::create(msg), "", "", 0, 0);
263     dispatchEvent(evt);
264 }
265
266 void WebSocket::didReceiveMessageError()
267 {
268     LOG(Network, "WebSocket %p didReceiveErrorMessage", this);
269     if (m_state != OPEN)
270         return;
271     ASSERT(scriptExecutionContext());
272     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
273 }
274
275 void WebSocket::didClose(unsigned long unhandledBufferedAmount)
276 {
277     LOG(Network, "WebSocket %p didClose", this);
278     if (!m_channel)
279         return;
280     m_state = CLOSED;
281     m_bufferedAmountAfterClose += unhandledBufferedAmount;
282     ASSERT(scriptExecutionContext());
283     dispatchEvent(Event::create(eventNames().closeEvent, false, false));
284     m_channel = 0;
285     if (hasPendingActivity())
286         ActiveDOMObject::unsetPendingActivity(this);
287 }
288
289 EventTargetData* WebSocket::eventTargetData()
290 {
291     return &m_eventTargetData;
292 }
293
294 EventTargetData* WebSocket::ensureEventTargetData()
295 {
296     return &m_eventTargetData;
297 }
298
299 }  // namespace WebCore
300
301 #endif