2011-05-25 Yuta Kitamura <yutak@chromium.org>
[WebKit-https.git] / Source / WebCore / websockets / WebSocketChannel.cpp
1 /*
2  * Copyright (C) 2011 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::fail(const String& reason)
125 {
126     LOG(Network, "WebSocketChannel %p fail: %s", this, reason.utf8().data());
127     ASSERT(!m_suspended);
128     if (m_context)
129         m_context->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, reason, 0, m_handshake.clientOrigin(), 0);
130     if (m_handle && !m_closed)
131         m_handle->close(); // Will call didClose().
132 }
133
134 void WebSocketChannel::disconnect()
135 {
136     LOG(Network, "WebSocketChannel %p disconnect", this);
137     if (m_identifier && m_context)
138         InspectorInstrumentation::didCloseWebSocket(m_context, m_identifier);
139     m_handshake.clearScriptExecutionContext();
140     m_client = 0;
141     m_context = 0;
142     if (m_handle)
143         m_handle->close();
144 }
145
146 void WebSocketChannel::suspend()
147 {
148     m_suspended = true;
149 }
150
151 void WebSocketChannel::resume()
152 {
153     m_suspended = false;
154     if ((m_buffer || m_closed) && m_client && !m_resumeTimer.isActive())
155         m_resumeTimer.startOneShot(0);
156 }
157
158 void WebSocketChannel::didOpen(SocketStreamHandle* handle)
159 {
160     LOG(Network, "WebSocketChannel %p didOpen", this);
161     ASSERT(handle == m_handle);
162     if (!m_context)
163         return;
164     if (m_identifier)
165         InspectorInstrumentation::willSendWebSocketHandshakeRequest(m_context, m_identifier, m_handshake.clientHandshakeRequest());
166     CString handshakeMessage = m_handshake.clientHandshakeMessage();
167     if (!handle->send(handshakeMessage.data(), handshakeMessage.length()))
168         fail("Failed to send WebSocket handshake.");
169 }
170
171 void WebSocketChannel::didClose(SocketStreamHandle* handle)
172 {
173     LOG(Network, "WebSocketChannel %p didClose", this);
174     if (m_identifier && m_context)
175         InspectorInstrumentation::didCloseWebSocket(m_context, m_identifier);
176     ASSERT_UNUSED(handle, handle == m_handle || !m_handle);
177     m_closed = true;
178     if (m_handle) {
179         m_unhandledBufferedAmount = m_handle->bufferedAmount();
180         if (m_suspended)
181             return;
182         WebSocketChannelClient* client = m_client;
183         m_client = 0;
184         m_context = 0;
185         m_handle = 0;
186         if (client)
187             client->didClose(m_unhandledBufferedAmount);
188     }
189     deref();
190 }
191
192 void WebSocketChannel::didReceiveData(SocketStreamHandle* handle, const char* data, int len)
193 {
194     LOG(Network, "WebSocketChannel %p didReceiveData %d", this, len);
195     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
196     ASSERT(handle == m_handle);
197     if (!m_context) {
198         return;
199     }
200     if (!m_client) {
201         m_shouldDiscardReceivedData = true;
202         handle->close();
203         return;
204     }
205     if (m_shouldDiscardReceivedData)
206         return;
207     if (!appendToBuffer(data, len)) {
208         m_shouldDiscardReceivedData = true;
209         fail("Ran out of memory while receiving WebSocket data.");
210         return;
211     }
212     while (!m_suspended && m_client && m_buffer)
213         if (!processBuffer())
214             break;
215 }
216
217 void WebSocketChannel::didFail(SocketStreamHandle* handle, const SocketStreamError& error)
218 {
219     LOG(Network, "WebSocketChannel %p didFail", this);
220     ASSERT(handle == m_handle || !m_handle);
221     if (m_context) {
222         String message;
223         if (error.isNull())
224             message = "WebSocket network error";
225         else if (error.localizedDescription().isNull())
226             message = "WebSocket network error: error code " + String::number(error.errorCode());
227         else
228             message = "WebSocket network error: " + error.localizedDescription();
229         String failingURL = error.failingURL();
230         ASSERT(failingURL.isNull() || m_handshake.url().string() == failingURL);
231         if (failingURL.isNull())
232             failingURL = m_handshake.url().string();
233         m_context->addMessage(OtherMessageSource, NetworkErrorMessageType, ErrorMessageLevel, message, 0, failingURL, 0);
234     }
235     m_shouldDiscardReceivedData = true;
236     handle->close();
237 }
238
239 void WebSocketChannel::didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
240 {
241 }
242
243 void WebSocketChannel::didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
244 {
245 }
246
247 bool WebSocketChannel::appendToBuffer(const char* data, size_t len)
248 {
249     size_t newBufferSize = m_bufferSize + len;
250     if (newBufferSize < m_bufferSize) {
251         LOG(Network, "WebSocket buffer overflow (%lu+%lu)", static_cast<unsigned long>(m_bufferSize), static_cast<unsigned long>(len));
252         return false;
253     }
254     char* newBuffer = 0;
255     if (!tryFastMalloc(newBufferSize).getValue(newBuffer))
256         return false;
257
258     if (m_buffer)
259         memcpy(newBuffer, m_buffer, m_bufferSize);
260     memcpy(newBuffer + m_bufferSize, data, len);
261     fastFree(m_buffer);
262     m_buffer = newBuffer;
263     m_bufferSize = newBufferSize;
264     return true;
265 }
266
267 void WebSocketChannel::skipBuffer(size_t len)
268 {
269     ASSERT(len <= m_bufferSize);
270     m_bufferSize -= len;
271     if (!m_bufferSize) {
272         fastFree(m_buffer);
273         m_buffer = 0;
274         return;
275     }
276     memmove(m_buffer, m_buffer + len, m_bufferSize);
277 }
278
279 bool WebSocketChannel::processBuffer()
280 {
281     ASSERT(!m_suspended);
282     ASSERT(m_client);
283     ASSERT(m_buffer);
284     if (m_shouldDiscardReceivedData)
285         return false;
286
287     if (m_handshake.mode() == WebSocketHandshake::Incomplete) {
288         int headerLength = m_handshake.readServerHandshake(m_buffer, m_bufferSize);
289         if (headerLength <= 0)
290             return false;
291         if (m_handshake.mode() == WebSocketHandshake::Connected) {
292             if (m_identifier)
293                 InspectorInstrumentation::didReceiveWebSocketHandshakeResponse(m_context, m_identifier, m_handshake.serverHandshakeResponse());
294             if (!m_handshake.serverSetCookie().isEmpty()) {
295                 if (m_context->isDocument()) {
296                     Document* document = static_cast<Document*>(m_context);
297                     if (cookiesEnabled(document)) {
298                         ExceptionCode ec; // Exception (for sandboxed documents) ignored.
299                         document->setCookie(m_handshake.serverSetCookie(), ec);
300                     }
301                 }
302             }
303             // FIXME: handle set-cookie2.
304             LOG(Network, "WebSocketChannel %p connected", this);
305             skipBuffer(headerLength);
306             m_client->didConnect();
307             LOG(Network, "remaining in read buf %lu", static_cast<unsigned long>(m_bufferSize));
308             return m_buffer;
309         }
310         LOG(Network, "WebSocketChannel %p connection failed", this);
311         skipBuffer(headerLength);
312         m_shouldDiscardReceivedData = true;
313         if (!m_closed)
314             m_handle->close();
315         return false;
316     }
317     if (m_handshake.mode() != WebSocketHandshake::Connected)
318         return false;
319
320     const char* nextFrame = m_buffer;
321     const char* p = m_buffer;
322     const char* end = p + m_bufferSize;
323
324     unsigned char frameByte = static_cast<unsigned char>(*p++);
325     if ((frameByte & 0x80) == 0x80) {
326         size_t length = 0;
327         bool errorFrame = false;
328         while (p < end) {
329             if (length > std::numeric_limits<size_t>::max() / 128) {
330                 LOG(Network, "frame length overflow %lu", static_cast<unsigned long>(length));
331                 errorFrame = true;
332                 break;
333             }
334             size_t newLength = length * 128;
335             unsigned char msgByte = static_cast<unsigned char>(*p);
336             unsigned int lengthMsgByte = msgByte & 0x7f;
337             if (newLength > std::numeric_limits<size_t>::max() - lengthMsgByte) {
338                 LOG(Network, "frame length overflow %lu+%u", static_cast<unsigned long>(newLength), lengthMsgByte);
339                 errorFrame = true;
340                 break;
341             }
342             newLength += lengthMsgByte;
343             if (newLength < length) { // sanity check
344                 LOG(Network, "frame length integer wrap %lu->%lu", static_cast<unsigned long>(length), static_cast<unsigned long>(newLength));
345                 errorFrame = true;
346                 break;
347             }
348             length = newLength;
349             ++p;
350             if (!(msgByte & 0x80))
351                 break;
352         }
353         if (p + length < p) {
354             LOG(Network, "frame buffer pointer wrap %p+%lu->%p", p, static_cast<unsigned long>(length), p + length);
355             errorFrame = true;
356         }
357         if (errorFrame) {
358             skipBuffer(m_bufferSize); // Save memory.
359             m_shouldDiscardReceivedData = true;
360             m_client->didReceiveMessageError();
361             fail("WebSocket frame length too large");
362             return false;
363         }
364         ASSERT(p + length >= p);
365         if (p + length < end) {
366             p += length;
367             nextFrame = p;
368             ASSERT(nextFrame > m_buffer);
369             skipBuffer(nextFrame - m_buffer);
370             m_client->didReceiveMessageError();
371             return m_buffer;
372         }
373         return false;
374     }
375
376     const char* msgStart = p;
377     while (p < end && *p != '\xff')
378         ++p;
379     if (p < end && *p == '\xff') {
380         int msgLength = p - msgStart;
381         ++p;
382         nextFrame = p;
383         if (frameByte == 0x00) {
384             String msg = String::fromUTF8(msgStart, msgLength);
385             skipBuffer(nextFrame - m_buffer);
386             m_client->didReceiveMessage(msg);
387         } else {
388             skipBuffer(nextFrame - m_buffer);
389             m_client->didReceiveMessageError();
390         }
391         return m_buffer;
392     }
393     return false;
394 }
395
396 void WebSocketChannel::resumeTimerFired(Timer<WebSocketChannel>* timer)
397 {
398     ASSERT_UNUSED(timer, timer == &m_resumeTimer);
399
400     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
401     while (!m_suspended && m_client && m_buffer)
402         if (!processBuffer())
403             break;
404     if (!m_suspended && m_client && m_closed && m_handle)
405         didClose(m_handle.get());
406 }
407
408 }  // namespace WebCore
409
410 #endif  // ENABLE(WEB_SOCKETS)