2009-12-01 Patrik Persson <patrik.j.persson@ericsson.com>
[WebKit-https.git] / WebCore / websockets / WebSocketChannel.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 "WebSocketChannel.h"
36
37 #include "CString.h"
38 #include "CookieJar.h"
39 #include "Document.h"
40 #include "Logging.h"
41 #include "PlatformString.h"
42 #include "ScriptExecutionContext.h"
43 #include "SocketStreamError.h"
44 #include "SocketStreamHandle.h"
45 #include "StringHash.h"
46 #include "WebSocketChannelClient.h"
47
48 #include <wtf/Deque.h>
49 #include <wtf/FastMalloc.h>
50 #include <wtf/HashMap.h>
51
52 namespace WebCore {
53
54 WebSocketChannel::WebSocketChannel(ScriptExecutionContext* context, WebSocketChannelClient* client, const KURL& url, const String& protocol)
55     : m_context(context)
56     , m_client(client)
57     , m_handshake(url, protocol, context)
58     , m_buffer(0)
59     , m_bufferSize(0)
60     , m_unhandledBufferSize(0)
61 {
62 }
63
64 WebSocketChannel::~WebSocketChannel()
65 {
66     fastFree(m_buffer);
67 }
68
69 void WebSocketChannel::connect()
70 {
71     LOG(Network, "WebSocketChannel %p connect", this);
72     ASSERT(!m_handle);
73     m_handshake.reset();
74     ref();
75     m_handle = SocketStreamHandle::create(m_handshake.url(), this);
76 }
77
78 bool WebSocketChannel::send(const String& msg)
79 {
80     LOG(Network, "WebSocketChannel %p send %s", this, msg.utf8().data());
81     Vector<char> buf;
82     buf.append('\0');  // frame type
83     buf.append(msg.utf8().data(), msg.utf8().length());
84     buf.append('\xff');  // frame end
85     if (!m_handle) {
86         m_unhandledBufferSize += buf.size();
87         return false;
88     }
89     return m_handle->send(buf.data(), buf.size());
90 }
91
92 unsigned long WebSocketChannel::bufferedAmount() const
93 {
94     LOG(Network, "WebSocketChannel %p bufferedAmount", this);
95     if (!m_handle)
96         return m_unhandledBufferSize;
97     return m_handle->bufferedAmount();
98 }
99
100 void WebSocketChannel::close()
101 {
102     LOG(Network, "WebSocketChannel %p close", this);
103     if (m_handle)
104         m_handle->close();  // will call didClose()
105 }
106
107 void WebSocketChannel::disconnect()
108 {
109     LOG(Network, "WebSocketChannel %p disconnect", this);
110     m_client = 0;
111     if (m_handle)
112         m_handle->close();
113 }
114
115 void WebSocketChannel::didOpen(SocketStreamHandle* handle)
116 {
117     LOG(Network, "WebSocketChannel %p didOpen", this);
118     ASSERT(handle == m_handle);
119     const CString& handshakeMessage = m_handshake.clientHandshakeMessage();
120     if (!handle->send(handshakeMessage.data(), handshakeMessage.length())) {
121         LOG(Network, "Error in sending handshake message.");
122         handle->close();
123     }
124 }
125
126 void WebSocketChannel::didClose(SocketStreamHandle* handle)
127 {
128     LOG(Network, "WebSocketChannel %p didClose", this);
129     ASSERT(handle == m_handle || !m_handle);
130     if (m_handle) {
131         m_unhandledBufferSize = handle->bufferedAmount();
132         WebSocketChannelClient* client = m_client;
133         m_client = 0;
134         m_handle = 0;
135         if (client)
136             client->didClose();
137     }
138     deref();
139 }
140
141 void WebSocketChannel::didReceiveData(SocketStreamHandle* handle, const char* data, int len)
142 {
143     LOG(Network, "WebSocketChannel %p didReceiveData %d", this, len);
144     ASSERT(handle == m_handle);
145     if (!appendToBuffer(data, len)) {
146         handle->close();
147         return;
148     }
149     if (!m_client) {
150         handle->close();
151         return;
152     }
153     if (m_handshake.mode() != WebSocketHandshake::Connected) {
154         int headerLength = m_handshake.readServerHandshake(m_buffer, m_bufferSize);
155         if (headerLength <= 0)
156             return;
157         switch (m_handshake.mode()) {
158         case WebSocketHandshake::Connected:
159             if (!m_handshake.serverSetCookie().isEmpty()) {
160                 if (m_context->isDocument()) {
161                     Document* document = static_cast<Document*>(m_context);
162                     if (cookiesEnabled(document)) {
163                         ExceptionCode ec; // Exception (for sandboxed documents) ignored.
164                         document->setCookie(m_handshake.serverSetCookie(), ec);
165                     }
166                 }
167             }
168             // FIXME: handle set-cookie2.
169             LOG(Network, "WebSocketChannel %p connected", this);
170             m_client->didConnect();
171             break;
172         default:
173             LOG(Network, "WebSocketChannel %p connection failed", this);
174             handle->close();
175             return;
176         }
177         skipBuffer(headerLength);
178         if (!m_buffer)
179             return;
180         LOG(Network, "remaining in read buf %ul", m_bufferSize);
181     }
182
183     const char* nextFrame = m_buffer;
184     const char* p = m_buffer;
185     const char* end = p + m_bufferSize;
186     while (p < end) {
187         unsigned char frameByte = static_cast<unsigned char>(*p++);
188         if ((frameByte & 0x80) == 0x80) {
189             int length = 0;
190             while (p < end && (*p & 0x80) == 0x80) {
191                 if (length > std::numeric_limits<int>::max() / 128) {
192                     LOG(Network, "frame length overflow %d", length);
193                     handle->close();
194                     return;
195                 }
196                 length = length * 128 + (*p & 0x7f);
197                 ++p;
198             }
199             if (p + length < end) {
200                 p += length;
201                 nextFrame = p;
202             } else
203                 break;
204         } else {
205             const char* msgStart = p;
206             while (p < end && *p != '\xff')
207                 ++p;
208             if (p < end && *p == '\xff') {
209                 if (frameByte == 0x00)
210                     m_client->didReceiveMessage(String::fromUTF8(msgStart, p - msgStart));
211                 ++p;
212                 nextFrame = p;
213             }
214         }
215     }
216     skipBuffer(nextFrame - m_buffer);
217 }
218
219 void WebSocketChannel::didFail(SocketStreamHandle* handle, const SocketStreamError&)
220 {
221     LOG(Network, "WebSocketChannel %p didFail", this);
222     ASSERT(handle == m_handle || !m_handle);
223     handle->close();
224 }
225
226 void WebSocketChannel::didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
227 {
228 }
229
230 void WebSocketChannel::didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
231 {
232 }
233
234 bool WebSocketChannel::appendToBuffer(const char* data, int len)
235 {
236     char* newBuffer = 0;
237     if (tryFastMalloc(m_bufferSize + len).getValue(newBuffer)) {
238         if (m_buffer)
239             memcpy(newBuffer, m_buffer, m_bufferSize);
240         memcpy(newBuffer + m_bufferSize, data, len);
241         fastFree(m_buffer);
242         m_buffer = newBuffer;
243         m_bufferSize += len;
244         return true;
245     }
246     LOG(Network, "Too long WebSocket frame %d", m_bufferSize + len);
247     return false;
248 }
249
250 void WebSocketChannel::skipBuffer(int len)
251 {
252     ASSERT(len <= m_bufferSize);
253     m_bufferSize -= len;
254     if (!m_bufferSize) {
255         fastFree(m_buffer);
256         m_buffer = 0;
257         return;
258     }
259     memmove(m_buffer, m_buffer + len, m_bufferSize);
260 }
261
262 }  // namespace WebCore
263
264 #endif  // ENABLE(WEB_SOCKETS)