Move WebCore into Source
[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 "PlatformString.h"
43 #include "ProgressTracker.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/StringConcatenate.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());
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 = makeString("WebSocket network error: error code ", String::number(error.errorCode()));
219         else
220             message = makeString("WebSocket network error: ", error.localizedDescription());
221         m_context->addMessage(OtherMessageSource, NetworkErrorMessageType, ErrorMessageLevel, message, 0, error.failingURL());
222     }
223     m_shouldDiscardReceivedData = true;
224     handle->close();
225 }
226
227 void WebSocketChannel::didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
228 {
229 }
230
231 void WebSocketChannel::didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
232 {
233 }
234
235 bool WebSocketChannel::appendToBuffer(const char* data, size_t len)
236 {
237     size_t newBufferSize = m_bufferSize + len;
238     if (newBufferSize < m_bufferSize) {
239         LOG(Network, "WebSocket buffer overflow (%lu+%lu)", static_cast<unsigned long>(m_bufferSize), static_cast<unsigned long>(len));
240         return false;
241     }
242     char* newBuffer = 0;
243     if (tryFastMalloc(newBufferSize).getValue(newBuffer)) {
244         if (m_buffer)
245             memcpy(newBuffer, m_buffer, m_bufferSize);
246         memcpy(newBuffer + m_bufferSize, data, len);
247         fastFree(m_buffer);
248         m_buffer = newBuffer;
249         m_bufferSize = newBufferSize;
250         return true;
251     }
252     m_context->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, makeString("WebSocket frame (at ", String::number(static_cast<unsigned long>(newBufferSize)), " bytes) is too long."), 0, m_handshake.clientOrigin());
253     return false;
254 }
255
256 void WebSocketChannel::skipBuffer(size_t len)
257 {
258     ASSERT(len <= m_bufferSize);
259     m_bufferSize -= len;
260     if (!m_bufferSize) {
261         fastFree(m_buffer);
262         m_buffer = 0;
263         return;
264     }
265     memmove(m_buffer, m_buffer + len, m_bufferSize);
266 }
267
268 bool WebSocketChannel::processBuffer()
269 {
270     ASSERT(!m_suspended);
271     ASSERT(m_client);
272     ASSERT(m_buffer);
273     if (m_shouldDiscardReceivedData)
274         return false;
275
276     if (m_handshake.mode() == WebSocketHandshake::Incomplete) {
277         int headerLength = m_handshake.readServerHandshake(m_buffer, m_bufferSize);
278         if (headerLength <= 0)
279             return false;
280         if (m_handshake.mode() == WebSocketHandshake::Connected) {
281             if (m_identifier)
282                 InspectorInstrumentation::didReceiveWebSocketHandshakeResponse(m_context, m_identifier, m_handshake.serverHandshakeResponse());
283             if (!m_handshake.serverSetCookie().isEmpty()) {
284                 if (m_context->isDocument()) {
285                     Document* document = static_cast<Document*>(m_context);
286                     if (cookiesEnabled(document)) {
287                         ExceptionCode ec; // Exception (for sandboxed documents) ignored.
288                         document->setCookie(m_handshake.serverSetCookie(), ec);
289                     }
290                 }
291             }
292             // FIXME: handle set-cookie2.
293             LOG(Network, "WebSocketChannel %p connected", this);
294             skipBuffer(headerLength);
295             m_client->didConnect();
296             LOG(Network, "remaining in read buf %lu", static_cast<unsigned long>(m_bufferSize));
297             return m_buffer;
298         }
299         LOG(Network, "WebSocketChannel %p connection failed", this);
300         skipBuffer(headerLength);
301         m_shouldDiscardReceivedData = true;
302         if (!m_closed)
303             m_handle->close();
304         return false;
305     }
306     if (m_handshake.mode() != WebSocketHandshake::Connected)
307         return false;
308
309     const char* nextFrame = m_buffer;
310     const char* p = m_buffer;
311     const char* end = p + m_bufferSize;
312
313     unsigned char frameByte = static_cast<unsigned char>(*p++);
314     if ((frameByte & 0x80) == 0x80) {
315         size_t length = 0;
316         bool errorFrame = false;
317         while (p < end) {
318             if (length > std::numeric_limits<size_t>::max() / 128) {
319                 LOG(Network, "frame length overflow %lu", static_cast<unsigned long>(length));
320                 errorFrame = true;
321                 break;
322             }
323             size_t newLength = length * 128;
324             unsigned char msgByte = static_cast<unsigned char>(*p);
325             unsigned int lengthMsgByte = msgByte & 0x7f;
326             if (newLength > std::numeric_limits<size_t>::max() - lengthMsgByte) {
327                 LOG(Network, "frame length overflow %lu+%u", static_cast<unsigned long>(newLength), lengthMsgByte);
328                 errorFrame = true;
329                 break;
330             }
331             newLength += lengthMsgByte;
332             if (newLength < length) { // sanity check
333                 LOG(Network, "frame length integer wrap %lu->%lu", static_cast<unsigned long>(length), static_cast<unsigned long>(newLength));
334                 errorFrame = true;
335                 break;
336             }
337             length = newLength;
338             ++p;
339             if (!(msgByte & 0x80))
340                 break;
341         }
342         if (p + length < p) {
343             LOG(Network, "frame buffer pointer wrap %p+%lu->%p", p, static_cast<unsigned long>(length), p + length);
344             errorFrame = true;
345         }
346         if (errorFrame) {
347             skipBuffer(m_bufferSize); // Save memory.
348             m_shouldDiscardReceivedData = true;
349             m_client->didReceiveMessageError();
350             if (!m_client)
351                 return false;
352             if (!m_closed)
353                 m_handle->close();
354             return false;
355         }
356         ASSERT(p + length >= p);
357         if (p + length < end) {
358             p += length;
359             nextFrame = p;
360             ASSERT(nextFrame > m_buffer);
361             skipBuffer(nextFrame - m_buffer);
362             m_client->didReceiveMessageError();
363             return m_buffer;
364         }
365         return false;
366     }
367
368     const char* msgStart = p;
369     while (p < end && *p != '\xff')
370         ++p;
371     if (p < end && *p == '\xff') {
372         int msgLength = p - msgStart;
373         ++p;
374         nextFrame = p;
375         if (frameByte == 0x00) {
376             String msg = String::fromUTF8(msgStart, msgLength);
377             skipBuffer(nextFrame - m_buffer);
378             m_client->didReceiveMessage(msg);
379         } else {
380             skipBuffer(nextFrame - m_buffer);
381             m_client->didReceiveMessageError();
382         }
383         return m_buffer;
384     }
385     return false;
386 }
387
388 void WebSocketChannel::resumeTimerFired(Timer<WebSocketChannel>* timer)
389 {
390     ASSERT_UNUSED(timer, timer == &m_resumeTimer);
391
392     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
393     while (!m_suspended && m_client && m_buffer)
394         if (!processBuffer())
395             break;
396     if (!m_suspended && m_client && m_closed && m_handle)
397         didClose(m_handle.get());
398 }
399
400 }  // namespace WebCore
401
402 #endif  // ENABLE(WEB_SOCKETS)