2010-08-13 Fumitoshi Ukai <ukai@chromium.org>
[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 "CookieJar.h"
38 #include "Document.h"
39 #include "Logging.h"
40 #include "PlatformString.h"
41 #include "ScriptExecutionContext.h"
42 #include "SocketStreamError.h"
43 #include "SocketStreamHandle.h"
44 #include "WebSocketChannelClient.h"
45 #include "WebSocketHandshake.h"
46
47 #include <wtf/text/CString.h>
48 #include <wtf/text/StringHash.h>
49 #include <wtf/Deque.h>
50 #include <wtf/FastMalloc.h>
51 #include <wtf/HashMap.h>
52
53 namespace WebCore {
54
55 WebSocketChannel::WebSocketChannel(ScriptExecutionContext* context, WebSocketChannelClient* client, const KURL& url, const String& protocol)
56     : m_context(context)
57     , m_client(client)
58     , m_handshake(url, protocol, context)
59     , m_buffer(0)
60     , m_bufferSize(0)
61     , m_resumeTimer(this, &WebSocketChannel::resumeTimerFired)
62     , m_suspended(false)
63     , m_closed(false)
64     , m_shouldDiscardReceivedData(false)
65     , m_unhandledBufferedAmount(0)
66 {
67 }
68
69 WebSocketChannel::~WebSocketChannel()
70 {
71     fastFree(m_buffer);
72 }
73
74 void WebSocketChannel::connect()
75 {
76     LOG(Network, "WebSocketChannel %p connect", this);
77     ASSERT(!m_handle);
78     ASSERT(!m_suspended);
79     m_handshake.reset();
80     ref();
81     m_handle = SocketStreamHandle::create(m_handshake.url(), this);
82 }
83
84 bool WebSocketChannel::send(const String& msg)
85 {
86     LOG(Network, "WebSocketChannel %p send %s", this, msg.utf8().data());
87     ASSERT(m_handle);
88     ASSERT(!m_suspended);
89     Vector<char> buf;
90     buf.append('\0');  // frame type
91     buf.append(msg.utf8().data(), msg.utf8().length());
92     buf.append('\xff');  // frame end
93     return m_handle->send(buf.data(), buf.size());
94 }
95
96 unsigned long WebSocketChannel::bufferedAmount() const
97 {
98     LOG(Network, "WebSocketChannel %p bufferedAmount", this);
99     ASSERT(m_handle);
100     ASSERT(!m_suspended);
101     return m_handle->bufferedAmount();
102 }
103
104 void WebSocketChannel::close()
105 {
106     LOG(Network, "WebSocketChannel %p close", this);
107     ASSERT(!m_suspended);
108     if (m_handle)
109         m_handle->close();  // will call didClose()
110 }
111
112 void WebSocketChannel::disconnect()
113 {
114     LOG(Network, "WebSocketChannel %p disconnect", this);
115     m_handshake.clearScriptExecutionContext();
116     m_client = 0;
117     m_context = 0;
118     if (m_handle)
119         m_handle->close();
120 }
121
122 void WebSocketChannel::suspend()
123 {
124     m_suspended = true;
125 }
126
127 void WebSocketChannel::resume()
128 {
129     m_suspended = false;
130     if ((m_buffer || m_closed) && m_client && !m_resumeTimer.isActive())
131         m_resumeTimer.startOneShot(0);
132 }
133
134 void WebSocketChannel::didOpen(SocketStreamHandle* handle)
135 {
136     LOG(Network, "WebSocketChannel %p didOpen", this);
137     ASSERT(handle == m_handle);
138     if (!m_context)
139         return;
140     const CString& handshakeMessage = m_handshake.clientHandshakeMessage();
141     if (!handle->send(handshakeMessage.data(), handshakeMessage.length())) {
142         m_context->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Error sending handshake message.", 0, m_handshake.clientOrigin());
143         handle->close();
144     }
145 }
146
147 void WebSocketChannel::didClose(SocketStreamHandle* handle)
148 {
149     LOG(Network, "WebSocketChannel %p didClose", this);
150     ASSERT_UNUSED(handle, handle == m_handle || !m_handle);
151     m_closed = true;
152     if (m_handle) {
153         m_unhandledBufferedAmount = m_handle->bufferedAmount();
154         if (m_suspended)
155             return;
156         WebSocketChannelClient* client = m_client;
157         m_client = 0;
158         m_context = 0;
159         m_handle = 0;
160         if (client)
161             client->didClose(m_unhandledBufferedAmount);
162     }
163     deref();
164 }
165
166 void WebSocketChannel::didReceiveData(SocketStreamHandle* handle, const char* data, int len)
167 {
168     LOG(Network, "WebSocketChannel %p didReceiveData %d", this, len);
169     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
170     ASSERT(handle == m_handle);
171     if (!m_context) {
172         return;
173     }
174     if (!m_client) {
175         m_shouldDiscardReceivedData = true;
176         handle->close();
177         return;
178     }
179     if (m_shouldDiscardReceivedData)
180         return;
181     if (!appendToBuffer(data, len)) {
182         m_shouldDiscardReceivedData = true;
183         handle->close();
184         return;
185     }
186     while (!m_suspended && m_client && m_buffer)
187         if (!processBuffer())
188             break;
189 }
190
191 void WebSocketChannel::didFail(SocketStreamHandle* handle, const SocketStreamError&)
192 {
193     LOG(Network, "WebSocketChannel %p didFail", this);
194     ASSERT(handle == m_handle || !m_handle);
195     m_shouldDiscardReceivedData = true;
196     handle->close();
197 }
198
199 void WebSocketChannel::didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
200 {
201 }
202
203 void WebSocketChannel::didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
204 {
205 }
206
207 bool WebSocketChannel::appendToBuffer(const char* data, size_t len)
208 {
209     size_t newBufferSize = m_bufferSize + len;
210     if (newBufferSize < m_bufferSize) {
211         LOG(Network, "WebSocket buffer overflow (%lu+%lu)", static_cast<unsigned long>(m_bufferSize), static_cast<unsigned long>(len));
212         return false;
213     }
214     char* newBuffer = 0;
215     if (tryFastMalloc(newBufferSize).getValue(newBuffer)) {
216         if (m_buffer)
217             memcpy(newBuffer, m_buffer, m_bufferSize);
218         memcpy(newBuffer + m_bufferSize, data, len);
219         fastFree(m_buffer);
220         m_buffer = newBuffer;
221         m_bufferSize = newBufferSize;
222         return true;
223     }
224     m_context->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, String::format("WebSocket frame (at %lu bytes) is too long.", static_cast<unsigned long>(newBufferSize)), 0, m_handshake.clientOrigin());
225     return false;
226 }
227
228 void WebSocketChannel::skipBuffer(size_t len)
229 {
230     ASSERT(len <= m_bufferSize);
231     m_bufferSize -= len;
232     if (!m_bufferSize) {
233         fastFree(m_buffer);
234         m_buffer = 0;
235         return;
236     }
237     memmove(m_buffer, m_buffer + len, m_bufferSize);
238 }
239
240 bool WebSocketChannel::processBuffer()
241 {
242     ASSERT(!m_suspended);
243     ASSERT(m_client);
244     ASSERT(m_buffer);
245     if (m_shouldDiscardReceivedData)
246         return false;
247
248     if (m_handshake.mode() == WebSocketHandshake::Incomplete) {
249         int headerLength = m_handshake.readServerHandshake(m_buffer, m_bufferSize);
250         if (headerLength <= 0)
251             return false;
252         if (m_handshake.mode() == WebSocketHandshake::Connected) {
253             if (!m_handshake.serverSetCookie().isEmpty()) {
254                 if (m_context->isDocument()) {
255                     Document* document = static_cast<Document*>(m_context);
256                     if (cookiesEnabled(document)) {
257                         ExceptionCode ec; // Exception (for sandboxed documents) ignored.
258                         document->setCookie(m_handshake.serverSetCookie(), ec);
259                     }
260                 }
261             }
262             // FIXME: handle set-cookie2.
263             LOG(Network, "WebSocketChannel %p connected", this);
264             skipBuffer(headerLength);
265             m_client->didConnect();
266             LOG(Network, "remaining in read buf %lu", static_cast<unsigned long>(m_bufferSize));
267             return m_buffer;
268         }
269         LOG(Network, "WebSocketChannel %p connection failed", this);
270         skipBuffer(headerLength);
271         m_shouldDiscardReceivedData = true;
272         if (!m_closed)
273             m_handle->close();
274         return false;
275     }
276     if (m_handshake.mode() != WebSocketHandshake::Connected)
277         return false;
278
279     const char* nextFrame = m_buffer;
280     const char* p = m_buffer;
281     const char* end = p + m_bufferSize;
282
283     unsigned char frameByte = static_cast<unsigned char>(*p++);
284     if ((frameByte & 0x80) == 0x80) {
285         size_t length = 0;
286         bool errorFrame = false;
287         while (p < end) {
288             if (length > std::numeric_limits<size_t>::max() / 128) {
289                 LOG(Network, "frame length overflow %lu", static_cast<unsigned long>(length));
290                 errorFrame = true;
291                 break;
292             }
293             size_t newLength = length * 128;
294             unsigned char msgByte = static_cast<unsigned char>(*p);
295             unsigned int lengthMsgByte = msgByte & 0x7f;
296             if (newLength > std::numeric_limits<size_t>::max() - lengthMsgByte) {
297                 LOG(Network, "frame length overflow %lu+%u", static_cast<unsigned long>(newLength), lengthMsgByte);
298                 errorFrame = true;
299                 break;
300             }
301             newLength += lengthMsgByte;
302             if (newLength < length) { // sanity check
303                 LOG(Network, "frame length integer wrap %lu->%lu", static_cast<unsigned long>(length), static_cast<unsigned long>(newLength));
304                 errorFrame = true;
305                 break;
306             }
307             length = newLength;
308             ++p;
309             if (!(msgByte & 0x80))
310                 break;
311         }
312         if (p + length < p) {
313             LOG(Network, "frame buffer pointer wrap %p+%lu->%p", p, static_cast<unsigned long>(length), p + length);
314             errorFrame = true;
315         }
316         if (errorFrame) {
317             skipBuffer(m_bufferSize); // Save memory.
318             m_shouldDiscardReceivedData = true;
319             m_client->didReceiveMessageError();
320             if (!m_client)
321                 return false;
322             if (!m_closed)
323                 m_handle->close();
324             return false;
325         }
326         ASSERT(p + length >= p);
327         if (p + length < end) {
328             p += length;
329             nextFrame = p;
330             ASSERT(nextFrame > m_buffer);
331             skipBuffer(nextFrame - m_buffer);
332             m_client->didReceiveMessageError();
333             return m_buffer;
334         }
335         return false;
336     }
337
338     const char* msgStart = p;
339     while (p < end && *p != '\xff')
340         ++p;
341     if (p < end && *p == '\xff') {
342         int msgLength = p - msgStart;
343         ++p;
344         nextFrame = p;
345         if (frameByte == 0x00) {
346             String msg = String::fromUTF8(msgStart, msgLength);
347             skipBuffer(nextFrame - m_buffer);
348             m_client->didReceiveMessage(msg);
349         } else {
350             skipBuffer(nextFrame - m_buffer);
351             m_client->didReceiveMessageError();
352         }
353         return m_buffer;
354     }
355     return false;
356 }
357
358 void WebSocketChannel::resumeTimerFired(Timer<WebSocketChannel>* timer)
359 {
360     ASSERT_UNUSED(timer, timer == &m_resumeTimer);
361
362     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
363     while (!m_suspended && m_client && m_buffer)
364         if (!processBuffer())
365             break;
366     if (!m_suspended && m_client && m_closed && m_handle)
367         didClose(m_handle.get());
368 }
369
370 }  // namespace WebCore
371
372 #endif  // ENABLE(WEB_SOCKETS)