2009-09-07 Fumitoshi Ukai <ukai@chromium.org>
[WebKit-https.git] / 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 "CString.h"
38 #include "CookieJar.h"
39 #include "Document.h"
40 #include "Logging.h"
41 #include "PlatformString.h"
42 #include "ScriptExecutionContext.h"
43 #include "SocketStreamError.h"
44 #include "SocketStreamHandle.h"
45 #include "StringHash.h"
46 #include "WebSocketChannelClient.h"
47
48 #include <wtf/Deque.h>
49 #include <wtf/FastMalloc.h>
50 #include <wtf/HashMap.h>
51
52 namespace WebCore {
53
54 WebSocketChannel::WebSocketChannel(ScriptExecutionContext* context, WebSocketChannelClient* client, const KURL& url, const String& protocol)
55     : m_context(context)
56     , m_client(client)
57     , m_handshake(url, protocol, context)
58     , m_buffer(0)
59     , m_bufferSize(0)
60     , m_unhandledBufferSize(0)
61 {
62 }
63
64 WebSocketChannel::~WebSocketChannel()
65 {
66     fastFree(m_buffer);
67 }
68
69 void WebSocketChannel::connect()
70 {
71     LOG(Network, "WebSocketChannel %p connect", this);
72     ASSERT(!m_handle.get());
73     m_handshake.reset();
74     m_handle = SocketStreamHandle::create(m_handshake.url(), this);
75 }
76
77 bool WebSocketChannel::send(const String& msg)
78 {
79     LOG(Network, "WebSocketChannel %p send %s", this, msg.utf8().data());
80     Vector<char> buf;
81     buf.append('\0');  // frame type
82     buf.append(msg.utf8().data(), msg.utf8().length());
83     buf.append('\xff');  // frame end
84     if (!m_handle.get()) {
85         m_unhandledBufferSize += buf.size();
86         return false;
87     }
88     return m_handle->send(buf.data(), buf.size());
89 }
90
91 unsigned long WebSocketChannel::bufferedAmount() const
92 {
93     LOG(Network, "WebSocketChannel %p bufferedAmount", this);
94     if (!m_handle.get())
95         return m_unhandledBufferSize;
96     return m_handle->bufferedAmount();
97 }
98
99 void WebSocketChannel::close()
100 {
101     LOG(Network, "WebSocketChannel %p close", this);
102     if (m_handle.get())
103         m_handle->close();  // will call didClose()
104 }
105
106 void WebSocketChannel::willOpenStream(SocketStreamHandle*, const KURL&)
107 {
108 }
109
110 void WebSocketChannel::willSendData(SocketStreamHandle*, const char*, int)
111 {
112 }
113
114 void WebSocketChannel::didOpen(SocketStreamHandle* handle)
115 {
116     LOG(Network, "WebSocketChannel %p didOpen", this);
117     ASSERT(handle == m_handle.get());
118     const CString& handshakeMessage = m_handshake.clientHandshakeMessage();
119     if (!handle->send(handshakeMessage.data(), handshakeMessage.length())) {
120         LOG(Network, "Error in sending handshake message.");
121         handle->close();
122     }
123 }
124
125 void WebSocketChannel::didClose(SocketStreamHandle* handle)
126 {
127     LOG(Network, "WebSocketChannel %p didClose", this);
128     ASSERT(handle == m_handle.get() || !m_handle.get());
129     if (!m_handle.get())
130         return;
131     m_unhandledBufferSize = handle->bufferedAmount();
132     WebSocketChannelClient* client = m_client;
133     m_client = 0;
134     m_handle = 0;
135     client->didClose();
136 }
137
138 void WebSocketChannel::didReceiveData(SocketStreamHandle* handle, const char* data, int len)
139 {
140     LOG(Network, "WebSocketChannel %p didReceiveData %d", this, len);
141     ASSERT(handle == m_handle.get());
142     if (!appendToBuffer(data, len)) {
143         handle->close();
144         return;
145     }
146     if (m_handshake.mode() != WebSocketHandshake::Connected) {
147         int headerLength = m_handshake.readServerHandshake(m_buffer, m_bufferSize);
148         if (headerLength <= 0)
149             return;
150         switch (m_handshake.mode()) {
151         case WebSocketHandshake::Connected:
152             if (!m_handshake.serverSetCookie().isEmpty()) {
153                 if (m_context->isDocument()) {
154                     Document* document = static_cast<Document*>(m_context);
155                     if (cookiesEnabled(document))
156                         document->setCookie(m_handshake.serverSetCookie());
157                 }
158             }
159             // FIXME: handle set-cookie2.
160             LOG(Network, "WebSocketChannel %p connected", this);
161             m_client->didConnect();
162             break;
163         default:
164             LOG(Network, "WebSocketChannel %p connection failed", this);
165             handle->close();
166             return;
167         }
168         skipBuffer(headerLength);
169         if (!m_buffer)
170             return;
171         LOG(Network, "remaining in read buf %ul", m_bufferSize);
172     }
173
174     const char* nextFrame = m_buffer;
175     const char* p = m_buffer;
176     const char* end = p + m_bufferSize;
177     while (p < end) {
178         unsigned char frameByte = static_cast<unsigned char>(*p++);
179         if ((frameByte & 0x80) == 0x80) {
180             int length = 0;
181             while (p < end && (*p & 0x80) == 0x80) {
182                 if (length > std::numeric_limits<int>::max() / 128) {
183                     LOG(Network, "frame length overflow %d", length);
184                     handle->close();
185                     return;
186                 }
187                 length = length * 128 + *p & 0x7f;
188                 ++p;
189             }
190             if (p + length < end) {
191                 p += length;
192                 nextFrame = p;
193             }
194         } else {
195             const char* msgStart = p;
196             while (p < end && *p != '\xff')
197                 ++p;
198             if (p < end && *p == '\xff') {
199                 if (frameByte == 0x00)
200                     m_client->didReceiveMessage(String::fromUTF8(msgStart, p - msgStart));
201                 ++p;
202                 nextFrame = p;
203             }
204         }
205     }
206     skipBuffer(nextFrame - m_buffer);
207 }
208
209 void WebSocketChannel::didFail(SocketStreamHandle* handle, const SocketStreamError&)
210 {
211     LOG(Network, "WebSocketChannel %p didFail", this);
212     ASSERT(handle == m_handle.get() || !m_handle.get());
213     handle->close();
214 }
215
216 bool WebSocketChannel::appendToBuffer(const char* data, int len)
217 {
218     char* newBuffer = 0;
219     if (tryFastMalloc(m_bufferSize + len).getValue(newBuffer)) {
220         if (m_buffer)
221             memcpy(newBuffer, m_buffer, m_bufferSize);
222         memcpy(newBuffer + m_bufferSize, data, len);
223         fastFree(m_buffer);
224         m_buffer = newBuffer;
225         m_bufferSize += len;
226         return true;
227     }
228     LOG(Network, "Too long WebSocket frame %d", m_bufferSize + len);
229     return false;
230 }
231
232 void WebSocketChannel::skipBuffer(int len)
233 {
234     ASSERT(len <= m_bufferSize);
235     m_bufferSize -= len;
236     if (!m_bufferSize) {
237         fastFree(m_buffer);
238         m_buffer = 0;
239         return;
240     }
241     memmove(m_buffer, m_buffer + len, m_bufferSize);
242 }
243
244 }  // namespace WebCore
245
246 #endif  // ENABLE(WEB_SOCKETS)