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