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