WebSocket: Accept multiple subprotocols
[WebKit-https.git] / Source / 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 "CloseEvent.h"
38 #include "DOMWindow.h"
39 #include "Event.h"
40 #include "EventException.h"
41 #include "EventListener.h"
42 #include "EventNames.h"
43 #include "ExceptionCode.h"
44 #include "Logging.h"
45 #include "MessageEvent.h"
46 #include "ScriptCallStack.h"
47 #include "ScriptExecutionContext.h"
48 #include "SecurityOrigin.h"
49 #include "ThreadableWebSocketChannel.h"
50 #include "WebSocketChannel.h"
51 #include <wtf/HashSet.h>
52 #include <wtf/StdLibExtras.h>
53 #include <wtf/text/CString.h>
54 #include <wtf/text/StringBuilder.h>
55 #include <wtf/text/WTFString.h>
56
57 namespace WebCore {
58
59 static inline bool isValidProtocolCharacter(UChar character)
60 {
61     // Hybi-10 says "(Subprotocol string must consist of) characters in the range U+0021 to U+007E not including
62     // separator characters as defined in [RFC2616]."
63     const UChar minimumProtocolCharacter = '!'; // U+0021.
64     const UChar maximumProtocolCharacter = '~'; // U+007E.
65     return character >= minimumProtocolCharacter && character <= maximumProtocolCharacter
66         && character != '"' && character != '(' && character != ')' && character != ',' && character != '/'
67         && !(character >= ':' && character <= '@') // U+003A - U+0040 (':', ';', '<', '=', '>', '?', '@').
68         && !(character >= '[' && character <= ']') // U+005B - U+005D ('[', '\\', ']').
69         && character != '{' && character != '}';
70 }
71
72 static bool isValidProtocolString(const String& protocol)
73 {
74     if (protocol.isEmpty())
75         return false;
76     for (size_t i = 0; i < protocol.length(); ++i) {
77         if (!isValidProtocolCharacter(protocol[i]))
78             return false;
79     }
80     return true;
81 }
82
83 static bool isValidProtocolStringHixie76(const String& protocol)
84 {
85     if (protocol.isNull())
86         return true;
87     if (protocol.isEmpty())
88         return false;
89     const UChar* characters = protocol.characters();
90     for (size_t i = 0; i < protocol.length(); i++) {
91         if (characters[i] < 0x20 || characters[i] > 0x7E)
92             return false;
93     }
94     return true;
95 }
96
97 static String encodeProtocolString(const String& protocol)
98 {
99     StringBuilder builder;
100     for (size_t i = 0; i < protocol.length(); i++) {
101         if (protocol[i] < 0x20 || protocol[i] > 0x7E)
102             builder.append(String::format("\\u%04X", protocol[i]));
103         else if (protocol[i] == 0x5c)
104             builder.append("\\\\");
105         else
106             builder.append(protocol[i]);
107     }
108     return builder.toString();
109 }
110
111 static String joinStrings(const Vector<String>& strings, const char* separator)
112 {
113     StringBuilder builder;
114     for (size_t i = 0; i < strings.size(); ++i) {
115         if (i)
116             builder.append(separator);
117         builder.append(strings[i]);
118     }
119     return builder.toString();
120 }
121
122 static bool webSocketsAvailable = false;
123
124 void WebSocket::setIsAvailable(bool available)
125 {
126     webSocketsAvailable = available;
127 }
128
129 bool WebSocket::isAvailable()
130 {
131     return webSocketsAvailable;
132 }
133
134 WebSocket::WebSocket(ScriptExecutionContext* context)
135     : ActiveDOMObject(context, this)
136     , m_state(CONNECTING)
137     , m_bufferedAmountAfterClose(0)
138 {
139 }
140
141 WebSocket::~WebSocket()
142 {
143     if (m_channel)
144         m_channel->disconnect();
145 }
146
147 void WebSocket::connect(const String& url, ExceptionCode& ec)
148 {
149     Vector<String> protocols;
150     connect(url, protocols, ec);
151 }
152
153 void WebSocket::connect(const String& url, const String& protocol, ExceptionCode& ec)
154 {
155     Vector<String> protocols;
156     protocols.append(protocol);
157     connect(url, protocols, ec);
158 }
159
160 void WebSocket::connect(const String& url, const Vector<String>& protocols, ExceptionCode& ec)
161 {
162     LOG(Network, "WebSocket %p connect to %s", this, url.utf8().data());
163     m_url = KURL(KURL(), url);
164
165     if (!m_url.isValid()) {
166         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Invalid url for WebSocket " + m_url.string(), 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
167         m_state = CLOSED;
168         ec = SYNTAX_ERR;
169         return;
170     }
171
172     if (!m_url.protocolIs("ws") && !m_url.protocolIs("wss")) {
173         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong url scheme for WebSocket " + m_url.string(), 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
174         m_state = CLOSED;
175         ec = SYNTAX_ERR;
176         return;
177     }
178     if (m_url.hasFragmentIdentifier()) {
179         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "URL has fragment component " + m_url.string(), 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
180         m_state = CLOSED;
181         ec = SYNTAX_ERR;
182         return;
183     }
184     if (!portAllowed(m_url)) {
185         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket port " + String::number(m_url.port()) + " blocked", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
186         m_state = CLOSED;
187         ec = SECURITY_ERR;
188         return;
189     }
190
191     m_channel = ThreadableWebSocketChannel::create(scriptExecutionContext(), this);
192
193     String protocolString;
194     if (m_channel->useHixie76Protocol()) {
195         if (!protocols.isEmpty()) {
196             // Emulate JavaScript's Array.toString() behavior.
197             protocolString = joinStrings(protocols, ",");
198         }
199         if (!isValidProtocolStringHixie76(protocolString)) {
200             scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(protocolString) + "'", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
201             m_state = CLOSED;
202             ec = SYNTAX_ERR;
203             return;
204         }
205     } else {
206         // FIXME: There is a disagreement about restriction of subprotocols between WebSocket API and hybi-10 protocol
207         // draft. The former simply says "only characters in the range U+0021 to U+007E are allowed," while the latter
208         // imposes a stricter rule: "the elements MUST be non-empty strings with characters as defined in [RFC2616],
209         // and MUST all be unique strings."
210         //
211         // Here, we throw SYNTAX_ERR if the given protocols do not meet the latter criteria. This behavior does not
212         // comply with WebSocket API specification, but it seems to be the only reasonable way to handle this conflict.
213         for (size_t i = 0; i < protocols.size(); ++i) {
214             if (!isValidProtocolString(protocols[i])) {
215                 scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(protocols[i]) + "'", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
216                 m_state = CLOSED;
217                 ec = SYNTAX_ERR;
218                 return;
219             }
220         }
221         HashSet<String> visited;
222         for (size_t i = 0; i < protocols.size(); ++i) {
223             if (visited.contains(protocols[i])) {
224                 scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket protocols contain duplicates: '" + encodeProtocolString(protocols[i]) + "'", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
225                 m_state = CLOSED;
226                 ec = SYNTAX_ERR;
227                 return;
228             }
229             visited.add(protocols[i]);
230         }
231
232         if (!protocols.isEmpty())
233             protocolString = joinStrings(protocols, ", ");
234     }
235
236     m_channel->connect(m_url, protocolString);
237     ActiveDOMObject::setPendingActivity(this);
238 }
239
240 bool WebSocket::send(const String& message, ExceptionCode& ec)
241 {
242     LOG(Network, "WebSocket %p send %s", this, message.utf8().data());
243     if (m_state == CONNECTING) {
244         ec = INVALID_STATE_ERR;
245         return false;
246     }
247     // No exception is raised if the connection was once established but has subsequently been closed.
248     if (m_state == CLOSING || m_state == CLOSED) {
249         m_bufferedAmountAfterClose += message.utf8().length() + 2; // 2 for frameing
250         return false;
251     }
252     // FIXME: check message is valid utf8.
253     ASSERT(m_channel);
254     return m_channel->send(message);
255 }
256
257 void WebSocket::close()
258 {
259     LOG(Network, "WebSocket %p close", this);
260     if (m_state == CLOSING || m_state == CLOSED)
261         return;
262     if (m_state == CONNECTING) {
263         m_state = CLOSING;
264         m_channel->fail("WebSocket is closed before the connection is established.");
265         return;
266     }
267     m_state = CLOSING;
268     m_bufferedAmountAfterClose = m_channel->bufferedAmount();
269     // didClose notification may be already queued, which we will inadvertently process while waiting for bufferedAmount() to return.
270     // In this case m_channel will be set to null during didClose() call, thus we need to test validness of m_channel here.
271     if (m_channel)
272         m_channel->close();
273 }
274
275 const KURL& WebSocket::url() const
276 {
277     return m_url;
278 }
279
280 WebSocket::State WebSocket::readyState() const
281 {
282     return m_state;
283 }
284
285 unsigned long WebSocket::bufferedAmount() const
286 {
287     if (m_state == OPEN)
288         return m_channel->bufferedAmount();
289     else if (m_state == CLOSING)
290         return m_channel->bufferedAmount() + m_bufferedAmountAfterClose;
291     return m_bufferedAmountAfterClose;
292 }
293
294 ScriptExecutionContext* WebSocket::scriptExecutionContext() const
295 {
296     return ActiveDOMObject::scriptExecutionContext();
297 }
298
299 void WebSocket::contextDestroyed()
300 {
301     LOG(Network, "WebSocket %p scriptExecutionContext destroyed", this);
302     ASSERT(!m_channel);
303     ASSERT(m_state == CLOSED);
304     ActiveDOMObject::contextDestroyed();
305 }
306
307 bool WebSocket::canSuspend() const
308 {
309     return !m_channel;
310 }
311
312 void WebSocket::suspend(ReasonForSuspension)
313 {
314     if (m_channel)
315         m_channel->suspend();
316 }
317
318 void WebSocket::resume()
319 {
320     if (m_channel)
321         m_channel->resume();
322 }
323
324 void WebSocket::stop()
325 {
326     bool pending = hasPendingActivity();
327     if (m_channel)
328         m_channel->disconnect();
329     m_channel = 0;
330     m_state = CLOSED;
331     ActiveDOMObject::stop();
332     if (pending)
333         ActiveDOMObject::unsetPendingActivity(this);
334 }
335
336 void WebSocket::didConnect()
337 {
338     LOG(Network, "WebSocket %p didConnect", this);
339     if (m_state != CONNECTING) {
340         didClose(0, ClosingHandshakeIncomplete);
341         return;
342     }
343     ASSERT(scriptExecutionContext());
344     m_state = OPEN;
345     dispatchEvent(Event::create(eventNames().openEvent, false, false));
346 }
347
348 void WebSocket::didReceiveMessage(const String& msg)
349 {
350     LOG(Network, "WebSocket %p didReceiveMessage %s", this, msg.utf8().data());
351     if (m_state != OPEN && m_state != CLOSING)
352         return;
353     ASSERT(scriptExecutionContext());
354     RefPtr<MessageEvent> evt = MessageEvent::create();
355     evt->initMessageEvent(eventNames().messageEvent, false, false, SerializedScriptValue::create(msg), "", "", 0, 0);
356     dispatchEvent(evt);
357 }
358
359 void WebSocket::didReceiveMessageError()
360 {
361     LOG(Network, "WebSocket %p didReceiveErrorMessage", this);
362     if (m_state != OPEN && m_state != CLOSING)
363         return;
364     ASSERT(scriptExecutionContext());
365     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
366 }
367
368 void WebSocket::didStartClosingHandshake()
369 {
370     LOG(Network, "WebSocket %p didStartClosingHandshake", this);
371     m_state = CLOSING;
372 }
373
374 void WebSocket::didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus closingHandshakeCompletion)
375 {
376     LOG(Network, "WebSocket %p didClose", this);
377     if (!m_channel)
378         return;
379     bool wasClean = m_state == CLOSING && !unhandledBufferedAmount && closingHandshakeCompletion == ClosingHandshakeComplete;
380     m_state = CLOSED;
381     m_bufferedAmountAfterClose += unhandledBufferedAmount;
382     ASSERT(scriptExecutionContext());
383     RefPtr<CloseEvent> event = CloseEvent::create(false);
384     event->initCloseEvent(eventNames().closeEvent, false, false, wasClean);
385     dispatchEvent(event);
386     if (m_channel) {
387         m_channel->disconnect();
388         m_channel = 0;
389     }
390     if (hasPendingActivity())
391         ActiveDOMObject::unsetPendingActivity(this);
392 }
393
394 EventTargetData* WebSocket::eventTargetData()
395 {
396     return &m_eventTargetData;
397 }
398
399 EventTargetData* WebSocket::ensureEventTargetData()
400 {
401     return &m_eventTargetData;
402 }
403
404 }  // namespace WebCore
405
406 #endif