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