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