a5b89490315803671a2830e11c461ce053c2c80a
[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     , m_binaryType(BinaryTypeBlob)
139 {
140 }
141
142 WebSocket::~WebSocket()
143 {
144     if (m_channel)
145         m_channel->disconnect();
146 }
147
148 void WebSocket::connect(const String& url, ExceptionCode& ec)
149 {
150     Vector<String> protocols;
151     connect(url, protocols, ec);
152 }
153
154 void WebSocket::connect(const String& url, const String& protocol, ExceptionCode& ec)
155 {
156     Vector<String> protocols;
157     protocols.append(protocol);
158     connect(url, protocols, ec);
159 }
160
161 void WebSocket::connect(const String& url, const Vector<String>& protocols, ExceptionCode& ec)
162 {
163     LOG(Network, "WebSocket %p connect to %s", this, url.utf8().data());
164     m_url = KURL(KURL(), url);
165
166     if (!m_url.isValid()) {
167         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Invalid url for WebSocket " + m_url.string(), 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
168         m_state = CLOSED;
169         ec = SYNTAX_ERR;
170         return;
171     }
172
173     if (!m_url.protocolIs("ws") && !m_url.protocolIs("wss")) {
174         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong url scheme for WebSocket " + m_url.string(), 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
175         m_state = CLOSED;
176         ec = SYNTAX_ERR;
177         return;
178     }
179     if (m_url.hasFragmentIdentifier()) {
180         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "URL has fragment component " + m_url.string(), 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
181         m_state = CLOSED;
182         ec = SYNTAX_ERR;
183         return;
184     }
185     if (!portAllowed(m_url)) {
186         scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket port " + String::number(m_url.port()) + " blocked", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
187         m_state = CLOSED;
188         ec = SECURITY_ERR;
189         return;
190     }
191
192     m_channel = ThreadableWebSocketChannel::create(scriptExecutionContext(), this);
193
194     String protocolString;
195     if (m_channel->useHixie76Protocol()) {
196         if (!protocols.isEmpty()) {
197             // Emulate JavaScript's Array.toString() behavior.
198             protocolString = joinStrings(protocols, ",");
199         }
200         if (!isValidProtocolStringHixie76(protocolString)) {
201             scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(protocolString) + "'", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
202             m_state = CLOSED;
203             ec = SYNTAX_ERR;
204             return;
205         }
206     } else {
207         // FIXME: There is a disagreement about restriction of subprotocols between WebSocket API and hybi-10 protocol
208         // draft. The former simply says "only characters in the range U+0021 to U+007E are allowed," while the latter
209         // imposes a stricter rule: "the elements MUST be non-empty strings with characters as defined in [RFC2616],
210         // and MUST all be unique strings."
211         //
212         // Here, we throw SYNTAX_ERR if the given protocols do not meet the latter criteria. This behavior does not
213         // comply with WebSocket API specification, but it seems to be the only reasonable way to handle this conflict.
214         for (size_t i = 0; i < protocols.size(); ++i) {
215             if (!isValidProtocolString(protocols[i])) {
216                 scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(protocols[i]) + "'", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
217                 m_state = CLOSED;
218                 ec = SYNTAX_ERR;
219                 return;
220             }
221         }
222         HashSet<String> visited;
223         for (size_t i = 0; i < protocols.size(); ++i) {
224             if (visited.contains(protocols[i])) {
225                 scriptExecutionContext()->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket protocols contain duplicates: '" + encodeProtocolString(protocols[i]) + "'", 0, scriptExecutionContext()->securityOrigin()->toString(), 0);
226                 m_state = CLOSED;
227                 ec = SYNTAX_ERR;
228                 return;
229             }
230             visited.add(protocols[i]);
231         }
232
233         if (!protocols.isEmpty())
234             protocolString = joinStrings(protocols, ", ");
235     }
236
237     m_channel->connect(m_url, protocolString);
238     ActiveDOMObject::setPendingActivity(this);
239 }
240
241 bool WebSocket::send(const String& message, ExceptionCode& ec)
242 {
243     LOG(Network, "WebSocket %p send %s", this, message.utf8().data());
244     if (m_state == CONNECTING) {
245         ec = INVALID_STATE_ERR;
246         return false;
247     }
248     // No exception is raised if the connection was once established but has subsequently been closed.
249     if (m_state == CLOSING || m_state == CLOSED) {
250         m_bufferedAmountAfterClose += message.utf8().length() + 2; // 2 for frameing
251         return false;
252     }
253     // FIXME: check message is valid utf8.
254     ASSERT(m_channel);
255     return m_channel->send(message);
256 }
257
258 void WebSocket::close()
259 {
260     LOG(Network, "WebSocket %p close", this);
261     if (m_state == CLOSING || m_state == CLOSED)
262         return;
263     if (m_state == CONNECTING) {
264         m_state = CLOSING;
265         m_channel->fail("WebSocket is closed before the connection is established.");
266         return;
267     }
268     m_state = CLOSING;
269     m_bufferedAmountAfterClose = m_channel->bufferedAmount();
270     // didClose notification may be already queued, which we will inadvertently process while waiting for bufferedAmount() to return.
271     // In this case m_channel will be set to null during didClose() call, thus we need to test validness of m_channel here.
272     if (m_channel)
273         m_channel->close();
274 }
275
276 const KURL& WebSocket::url() const
277 {
278     return m_url;
279 }
280
281 WebSocket::State WebSocket::readyState() const
282 {
283     return m_state;
284 }
285
286 unsigned long WebSocket::bufferedAmount() const
287 {
288     if (m_state == OPEN)
289         return m_channel->bufferedAmount();
290     else if (m_state == CLOSING)
291         return m_channel->bufferedAmount() + m_bufferedAmountAfterClose;
292     return m_bufferedAmountAfterClose;
293 }
294
295 String WebSocket::binaryType() const
296 {
297     if (m_channel->useHixie76Protocol())
298         return String();
299     switch (m_binaryType) {
300     case BinaryTypeBlob:
301         return "blob";
302     case BinaryTypeArrayBuffer:
303         return "arraybuffer";
304     }
305     ASSERT_NOT_REACHED();
306     return String();
307 }
308
309 void WebSocket::setBinaryType(const String& binaryType, ExceptionCode& ec)
310 {
311     if (m_channel->useHixie76Protocol())
312         return;
313     if (binaryType == "blob") {
314         m_binaryType = BinaryTypeBlob;
315         return;
316     }
317     if (binaryType == "arraybuffer") {
318         m_binaryType = BinaryTypeArrayBuffer;
319         return;
320     }
321     ec = SYNTAX_ERR;
322     return;
323 }
324
325 ScriptExecutionContext* WebSocket::scriptExecutionContext() const
326 {
327     return ActiveDOMObject::scriptExecutionContext();
328 }
329
330 void WebSocket::contextDestroyed()
331 {
332     LOG(Network, "WebSocket %p scriptExecutionContext destroyed", this);
333     ASSERT(!m_channel);
334     ASSERT(m_state == CLOSED);
335     ActiveDOMObject::contextDestroyed();
336 }
337
338 bool WebSocket::canSuspend() const
339 {
340     return !m_channel;
341 }
342
343 void WebSocket::suspend(ReasonForSuspension)
344 {
345     if (m_channel)
346         m_channel->suspend();
347 }
348
349 void WebSocket::resume()
350 {
351     if (m_channel)
352         m_channel->resume();
353 }
354
355 void WebSocket::stop()
356 {
357     bool pending = hasPendingActivity();
358     if (m_channel)
359         m_channel->disconnect();
360     m_channel = 0;
361     m_state = CLOSED;
362     ActiveDOMObject::stop();
363     if (pending)
364         ActiveDOMObject::unsetPendingActivity(this);
365 }
366
367 void WebSocket::didConnect()
368 {
369     LOG(Network, "WebSocket %p didConnect", this);
370     if (m_state != CONNECTING) {
371         didClose(0, ClosingHandshakeIncomplete);
372         return;
373     }
374     ASSERT(scriptExecutionContext());
375     m_state = OPEN;
376     dispatchEvent(Event::create(eventNames().openEvent, false, false));
377 }
378
379 void WebSocket::didReceiveMessage(const String& msg)
380 {
381     LOG(Network, "WebSocket %p didReceiveMessage %s", this, msg.utf8().data());
382     if (m_state != OPEN && m_state != CLOSING)
383         return;
384     ASSERT(scriptExecutionContext());
385     RefPtr<MessageEvent> evt = MessageEvent::create();
386     evt->initMessageEvent(eventNames().messageEvent, false, false, SerializedScriptValue::create(msg), "", "", 0, 0);
387     dispatchEvent(evt);
388 }
389
390 void WebSocket::didReceiveMessageError()
391 {
392     LOG(Network, "WebSocket %p didReceiveErrorMessage", this);
393     if (m_state != OPEN && m_state != CLOSING)
394         return;
395     ASSERT(scriptExecutionContext());
396     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
397 }
398
399 void WebSocket::didStartClosingHandshake()
400 {
401     LOG(Network, "WebSocket %p didStartClosingHandshake", this);
402     m_state = CLOSING;
403 }
404
405 void WebSocket::didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus closingHandshakeCompletion)
406 {
407     LOG(Network, "WebSocket %p didClose", this);
408     if (!m_channel)
409         return;
410     bool wasClean = m_state == CLOSING && !unhandledBufferedAmount && closingHandshakeCompletion == ClosingHandshakeComplete;
411     m_state = CLOSED;
412     m_bufferedAmountAfterClose += unhandledBufferedAmount;
413     ASSERT(scriptExecutionContext());
414     RefPtr<CloseEvent> event = CloseEvent::create(false);
415     event->initCloseEvent(eventNames().closeEvent, false, false, wasClean);
416     dispatchEvent(event);
417     if (m_channel) {
418         m_channel->disconnect();
419         m_channel = 0;
420     }
421     if (hasPendingActivity())
422         ActiveDOMObject::unsetPendingActivity(this);
423 }
424
425 EventTargetData* WebSocket::eventTargetData()
426 {
427     return &m_eventTargetData;
428 }
429
430 EventTargetData* WebSocket::ensureEventTargetData()
431 {
432     return &m_eventTargetData;
433 }
434
435 }  // namespace WebCore
436
437 #endif