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