2009-12-21 Fumitoshi Ukai <ukai@chromium.org>
[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 "CString.h"
38 #include "DOMWindow.h"
39 #include "Event.h"
40 #include "EventException.h"
41 #include "EventListener.h"
42 #include "EventNames.h"
43 #include "Logging.h"
44 #include "MessageEvent.h"
45 #include "ScriptExecutionContext.h"
46 #include "StringBuilder.h"
47 #include "WebSocketChannel.h"
48 #include <wtf/StdLibExtras.h>
49
50 namespace WebCore {
51
52 static bool isValidProtocolString(const String& protocol)
53 {
54     if (protocol.isNull())
55         return true;
56     if (protocol.isEmpty())
57         return false;
58     const UChar* characters = protocol.characters();
59     for (size_t i = 0; i < protocol.length(); i++) {
60         if (characters[i] < 0x20 || characters[i] > 0x7E)
61             return false;
62     }
63     return true;
64 }
65
66 static String encodeProtocolString(const String& protocol)
67 {
68     StringBuilder builder;
69     for (size_t i = 0; i < protocol.length(); i++) {
70         if (protocol[i] < 0x20 || protocol[i] > 0x7E)
71             builder.append(String::format("\\u%04X", protocol[i]));
72         else if (protocol[i] == 0x5c)
73             builder.append("\\\\");
74         else
75             builder.append(protocol[i]);
76     }
77     return builder.toString();
78 }
79
80 #if USE(V8)
81
82 static bool webSocketsAvailable = false;
83
84 void WebSocket::setIsAvailable(bool available)
85 {
86     webSocketsAvailable = available;
87 }
88
89 bool WebSocket::isAvailable()
90 {
91     return webSocketsAvailable;
92 }
93
94 #endif
95
96 WebSocket::WebSocket(ScriptExecutionContext* context)
97     : ActiveDOMObject(context, this)
98     , m_state(CONNECTING)
99 {
100 }
101
102 WebSocket::~WebSocket()
103 {
104     if (m_channel)
105         m_channel->disconnect();
106 }
107
108 void WebSocket::connect(const KURL& url, ExceptionCode& ec)
109 {
110     connect(url, String(), ec);
111 }
112
113 void WebSocket::connect(const KURL& url, const String& protocol, ExceptionCode& ec)
114 {
115     LOG(Network, "WebSocket %p connect to %s protocol=%s", this, url.string().utf8().data(), protocol.utf8().data());
116     m_url = url;
117     m_protocol = protocol;
118
119     if (!m_url.isValid()) {
120         scriptExecutionContext()->addMessage(ConsoleDestination, JSMessageSource, LogMessageType, ErrorMessageLevel, "Invalid url for WebSocket " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
121         m_state = CLOSED;
122         ec = SYNTAX_ERR;
123         return;
124     }
125
126     if (!m_url.protocolIs("ws") && !m_url.protocolIs("wss")) {
127         scriptExecutionContext()->addMessage(ConsoleDestination, JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong url scheme for WebSocket " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
128         m_state = CLOSED;
129         ec = SYNTAX_ERR;
130         return;
131     }
132     if (m_url.hasFragmentIdentifier()) {
133         scriptExecutionContext()->addMessage(ConsoleDestination, JSMessageSource, LogMessageType, ErrorMessageLevel, "URL has fragment component " + url.string(), 0, scriptExecutionContext()->securityOrigin()->toString());
134         m_state = CLOSED;
135         ec = SYNTAX_ERR;
136         return;
137     }
138     if (!isValidProtocolString(m_protocol)) {
139         scriptExecutionContext()->addMessage(ConsoleDestination, JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(m_protocol) + "'", 0, scriptExecutionContext()->securityOrigin()->toString());
140         m_state = CLOSED;
141         ec = SYNTAX_ERR;
142         return;
143     }
144     if (!portAllowed(url)) {
145         scriptExecutionContext()->addMessage(ConsoleDestination, JSMessageSource, LogMessageType, ErrorMessageLevel, String::format("WebSocket port %d blocked", url.port()), 0, scriptExecutionContext()->securityOrigin()->toString());
146         m_state = CLOSED;
147         ec = SECURITY_ERR;
148         return;
149     }
150
151     m_channel = WebSocketChannel::create(scriptExecutionContext(), this, m_url, m_protocol);
152     m_channel->connect();
153 }
154
155 bool WebSocket::send(const String& message, ExceptionCode& ec)
156 {
157     LOG(Network, "WebSocket %p send %s", this, message.utf8().data());
158     if (m_state == CONNECTING) {
159         ec = INVALID_STATE_ERR;
160         return false;
161     }
162     // No exception is raised if the connection was once established but has subsequently been closed.
163     if (m_state == CLOSED)
164         return false;
165     // FIXME: check message is valid utf8.
166     return m_channel->send(message);
167 }
168
169 void WebSocket::close()
170 {
171     LOG(Network, "WebSocket %p close", this);
172     if (m_state == CLOSED)
173         return;
174     m_state = CLOSED;
175     m_channel->close();
176 }
177
178 const KURL& WebSocket::url() const
179 {
180     return m_url;
181 }
182
183 WebSocket::State WebSocket::readyState() const
184 {
185     return m_state;
186 }
187
188 unsigned long WebSocket::bufferedAmount() const
189 {
190     if (m_state == OPEN)
191         return m_channel->bufferedAmount();
192     return 0;
193 }
194
195 ScriptExecutionContext* WebSocket::scriptExecutionContext() const
196 {
197     return ActiveDOMObject::scriptExecutionContext();
198 }
199
200 void WebSocket::didConnect()
201 {
202     LOG(Network, "WebSocket %p didConnect", this);
203     if (m_state != CONNECTING || !scriptExecutionContext()) {
204         didClose();
205         return;
206     }
207     m_state = OPEN;
208     dispatchEvent(Event::create(eventNames().openEvent, false, false));
209 }
210
211 void WebSocket::didReceiveMessage(const String& msg)
212 {
213     LOG(Network, "WebSocket %p didReceiveMessage %s", this, msg.utf8().data());
214     if (m_state != OPEN || !scriptExecutionContext())
215         return;
216     RefPtr<MessageEvent> evt = MessageEvent::create();
217     // FIXME: origin, lastEventId, source, messagePort.
218     evt->initMessageEvent(eventNames().messageEvent, false, false, SerializedScriptValue::create(msg), "", "", 0, 0);
219     dispatchEvent(evt);
220 }
221
222 void WebSocket::didClose()
223 {
224     LOG(Network, "WebSocket %p didClose", this);
225     m_state = CLOSED;
226     dispatchEvent(Event::create(eventNames().closeEvent, false, false));
227 }
228
229 EventTargetData* WebSocket::eventTargetData()
230 {
231     return &m_eventTargetData;
232 }
233
234 EventTargetData* WebSocket::ensureEventTargetData()
235 {
236     return &m_eventTargetData;
237 }
238
239 }  // namespace WebCore
240
241 #endif