91761fba76603c4ff8ff21c2015e68cc07d8166b
[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 #if USE(V8)
82
83 static bool webSocketsAvailable = false;
84
85 void WebSocket::setIsAvailable(bool available)
86 {
87     webSocketsAvailable = available;
88 }
89
90 bool WebSocket::isAvailable()
91 {
92     return webSocketsAvailable;
93 }
94
95 #endif
96
97 WebSocket::WebSocket(ScriptExecutionContext* context)
98     : ActiveDOMObject(context, this)
99     , m_state(CONNECTING)
100     , m_bufferedAmountAfterClose(0)
101 {
102 }
103
104 WebSocket::~WebSocket()
105 {
106     if (m_channel)
107         m_channel->disconnect();
108 }
109
110 void WebSocket::connect(const KURL& url, ExceptionCode& ec)
111 {
112     connect(url, String(), ec);
113 }
114
115 void WebSocket::connect(const KURL& url, const String& protocol, ExceptionCode& ec)
116 {
117     LOG(Network, "WebSocket %p connect to %s protocol=%s", this, url.string().utf8().data(), protocol.utf8().data());
118     m_url = url;
119     m_protocol = protocol;
120
121     if (!m_url.isValid()) {
122         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Invalid url for WebSocket " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
123         m_state = CLOSED;
124         ec = SYNTAX_ERR;
125         return;
126     }
127
128     if (!m_url.protocolIs("ws") && !m_url.protocolIs("wss")) {
129         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong url scheme for WebSocket " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
130         m_state = CLOSED;
131         ec = SYNTAX_ERR;
132         return;
133     }
134     if (m_url.hasFragmentIdentifier()) {
135         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "URL has fragment component " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
136         m_state = CLOSED;
137         ec = SYNTAX_ERR;
138         return;
139     }
140     if (!isValidProtocolString(m_protocol)) {
141         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(m_protocol) + "'", 0, scriptExecutionContext()->securityOrigin()->toString());
142         m_state = CLOSED;
143         ec = SYNTAX_ERR;
144         return;
145     }
146     if (!portAllowed(url)) {
147         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, String::format("WebSocket port %d blocked", url.port()), 0, scriptExecutionContext()->securityOrigin()->toString());
148         m_state = CLOSED;
149         ec = SECURITY_ERR;
150         return;
151     }
152
153     m_channel = ThreadableWebSocketChannel::create(scriptExecutionContext(), this, m_url, m_protocol);
154     m_channel->connect();
155     ActiveDOMObject::setPendingActivity(this);
156 }
157
158 bool WebSocket::send(const String& message, ExceptionCode& ec)
159 {
160     LOG(Network, "WebSocket %p send %s", this, message.utf8().data());
161     if (m_state == CONNECTING) {
162         ec = INVALID_STATE_ERR;
163         return false;
164     }
165     // No exception is raised if the connection was once established but has subsequently been closed.
166     if (m_state == CLOSED) {
167         m_bufferedAmountAfterClose += message.utf8().length() + 2; // 2 for frameing
168         return false;
169     }
170     // FIXME: check message is valid utf8.
171     ASSERT(m_channel);
172     return m_channel->send(message);
173 }
174
175 void WebSocket::close()
176 {
177     LOG(Network, "WebSocket %p close", this);
178     if (m_state == CLOSED)
179         return;
180     m_state = CLOSED;
181     m_bufferedAmountAfterClose = m_channel->bufferedAmount();
182     // didClose notification may be already queued, which we will inadvertently process while waiting for bufferedAmount() to return.
183     // In this case m_channel will be set to null during didClose() call, thus we need to test validness of m_channel here.
184     if (m_channel)
185         m_channel->close();
186 }
187
188 const KURL& WebSocket::url() const
189 {
190     return m_url;
191 }
192
193 WebSocket::State WebSocket::readyState() const
194 {
195     return m_state;
196 }
197
198 unsigned long WebSocket::bufferedAmount() const
199 {
200     if (m_state == OPEN)
201         return m_channel->bufferedAmount();
202     return m_bufferedAmountAfterClose;
203 }
204
205 ScriptExecutionContext* WebSocket::scriptExecutionContext() const
206 {
207     return ActiveDOMObject::scriptExecutionContext();
208 }
209
210 void WebSocket::contextDestroyed()
211 {
212     LOG(Network, "WebSocket %p scriptExecutionContext destroyed", this);
213     ASSERT(!m_channel);
214     ASSERT(m_state == CLOSED);
215     ActiveDOMObject::contextDestroyed();
216 }
217
218 bool WebSocket::canSuspend() const
219 {
220     return !m_channel;
221 }
222
223 void WebSocket::suspend()
224 {
225     if (m_channel)
226         m_channel->suspend();
227 }
228
229 void WebSocket::resume()
230 {
231     if (m_channel)
232         m_channel->resume();
233 }
234
235 void WebSocket::stop()
236 {
237     bool pending = hasPendingActivity();
238     if (m_channel)
239         m_channel->disconnect();
240     m_channel = 0;
241     m_state = CLOSED;
242     ActiveDOMObject::stop();
243     if (pending)
244         ActiveDOMObject::unsetPendingActivity(this);
245 }
246
247 void WebSocket::didConnect()
248 {
249     LOG(Network, "WebSocket %p didConnect", this);
250     if (m_state != CONNECTING) {
251         didClose(0);
252         return;
253     }
254     ASSERT(scriptExecutionContext());
255     m_state = OPEN;
256     dispatchEvent(Event::create(eventNames().openEvent, false, false));
257 }
258
259 void WebSocket::didReceiveMessage(const String& msg)
260 {
261     LOG(Network, "WebSocket %p didReceiveMessage %s", this, msg.utf8().data());
262     if (m_state != OPEN)
263         return;
264     ASSERT(scriptExecutionContext());
265     RefPtr<MessageEvent> evt = MessageEvent::create();
266     evt->initMessageEvent(eventNames().messageEvent, false, false, SerializedScriptValue::create(msg), "", "", 0, 0);
267     dispatchEvent(evt);
268 }
269
270 void WebSocket::didReceiveMessageError()
271 {
272     LOG(Network, "WebSocket %p didReceiveErrorMessage", this);
273     if (m_state != OPEN)
274         return;
275     ASSERT(scriptExecutionContext());
276     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
277 }
278
279 void WebSocket::didClose(unsigned long unhandledBufferedAmount)
280 {
281     LOG(Network, "WebSocket %p didClose", this);
282     if (!m_channel)
283         return;
284     m_state = CLOSED;
285     m_bufferedAmountAfterClose += unhandledBufferedAmount;
286     ASSERT(scriptExecutionContext());
287     dispatchEvent(Event::create(eventNames().closeEvent, false, false));
288     m_channel = 0;
289     if (hasPendingActivity())
290         ActiveDOMObject::unsetPendingActivity(this);
291 }
292
293 EventTargetData* WebSocket::eventTargetData()
294 {
295     return &m_eventTargetData;
296 }
297
298 EventTargetData* WebSocket::ensureEventTargetData()
299 {
300     return &m_eventTargetData;
301 }
302
303 }  // namespace WebCore
304
305 #endif