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