2009-10-27 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     ref();
75     m_handle = SocketStreamHandle::create(m_handshake.url(), this);
76 }
77
78 bool WebSocketChannel::send(const String& msg)
79 {
80     LOG(Network, "WebSocketChannel %p send %s", this, msg.utf8().data());
81     Vector<char> buf;
82     buf.append('\0');  // frame type
83     buf.append(msg.utf8().data(), msg.utf8().length());
84     buf.append('\xff');  // frame end
85     if (!m_handle.get()) {
86         m_unhandledBufferSize += buf.size();
87         return false;
88     }
89     return m_handle->send(buf.data(), buf.size());
90 }
91
92 unsigned long WebSocketChannel::bufferedAmount() const
93 {
94     LOG(Network, "WebSocketChannel %p bufferedAmount", this);
95     if (!m_handle.get())
96         return m_unhandledBufferSize;
97     return m_handle->bufferedAmount();
98 }
99
100 void WebSocketChannel::close()
101 {
102     LOG(Network, "WebSocketChannel %p close", this);
103     if (m_handle.get())
104         m_handle->close();  // will call didClose()
105 }
106
107 void WebSocketChannel::disconnect()
108 {
109     LOG(Network, "WebSocketChannel %p disconnect", this);
110     m_client = 0;
111     if (m_handle.get())
112         m_handle->close();
113 }
114
115 void WebSocketChannel::willOpenStream(SocketStreamHandle*, const KURL&)
116 {
117 }
118
119 void WebSocketChannel::willSendData(SocketStreamHandle*, const char*, int)
120 {
121 }
122
123 void WebSocketChannel::didOpen(SocketStreamHandle* handle)
124 {
125     LOG(Network, "WebSocketChannel %p didOpen", this);
126     ASSERT(handle == m_handle.get());
127     const CString& handshakeMessage = m_handshake.clientHandshakeMessage();
128     if (!handle->send(handshakeMessage.data(), handshakeMessage.length())) {
129         LOG(Network, "Error in sending handshake message.");
130         handle->close();
131     }
132 }
133
134 void WebSocketChannel::didClose(SocketStreamHandle* handle)
135 {
136     LOG(Network, "WebSocketChannel %p didClose", this);
137     ASSERT(handle == m_handle.get() || !m_handle.get());
138     if (m_handle.get()) {
139         m_unhandledBufferSize = handle->bufferedAmount();
140         WebSocketChannelClient* client = m_client;
141         m_client = 0;
142         m_handle = 0;
143         if (client)
144             client->didClose();
145     }
146     deref();
147 }
148
149 void WebSocketChannel::didReceiveData(SocketStreamHandle* handle, const char* data, int len)
150 {
151     LOG(Network, "WebSocketChannel %p didReceiveData %d", this, len);
152     ASSERT(handle == m_handle.get());
153     if (!appendToBuffer(data, len)) {
154         handle->close();
155         return;
156     }
157     if (!m_client) {
158         handle->close();
159         return;
160     }
161     if (m_handshake.mode() != WebSocketHandshake::Connected) {
162         int headerLength = m_handshake.readServerHandshake(m_buffer, m_bufferSize);
163         if (headerLength <= 0)
164             return;
165         switch (m_handshake.mode()) {
166         case WebSocketHandshake::Connected:
167             if (!m_handshake.serverSetCookie().isEmpty()) {
168                 if (m_context->isDocument()) {
169                     Document* document = static_cast<Document*>(m_context);
170                     if (cookiesEnabled(document))
171                         document->setCookie(m_handshake.serverSetCookie());
172                 }
173             }
174             // FIXME: handle set-cookie2.
175             LOG(Network, "WebSocketChannel %p connected", this);
176             m_client->didConnect();
177             break;
178         default:
179             LOG(Network, "WebSocketChannel %p connection failed", this);
180             handle->close();
181             return;
182         }
183         skipBuffer(headerLength);
184         if (!m_buffer)
185             return;
186         LOG(Network, "remaining in read buf %ul", m_bufferSize);
187     }
188
189     const char* nextFrame = m_buffer;
190     const char* p = m_buffer;
191     const char* end = p + m_bufferSize;
192     while (p < end) {
193         unsigned char frameByte = static_cast<unsigned char>(*p++);
194         if ((frameByte & 0x80) == 0x80) {
195             int length = 0;
196             while (p < end && (*p & 0x80) == 0x80) {
197                 if (length > std::numeric_limits<int>::max() / 128) {
198                     LOG(Network, "frame length overflow %d", length);
199                     handle->close();
200                     return;
201                 }
202                 length = length * 128 + (*p & 0x7f);
203                 ++p;
204             }
205             if (p + length < end) {
206                 p += length;
207                 nextFrame = p;
208             }
209         } else {
210             const char* msgStart = p;
211             while (p < end && *p != '\xff')
212                 ++p;
213             if (p < end && *p == '\xff') {
214                 if (frameByte == 0x00)
215                     m_client->didReceiveMessage(String::fromUTF8(msgStart, p - msgStart));
216                 ++p;
217                 nextFrame = p;
218             }
219         }
220     }
221     skipBuffer(nextFrame - m_buffer);
222 }
223
224 void WebSocketChannel::didFail(SocketStreamHandle* handle, const SocketStreamError&)
225 {
226     LOG(Network, "WebSocketChannel %p didFail", this);
227     ASSERT(handle == m_handle.get() || !m_handle.get());
228     handle->close();
229 }
230
231 bool WebSocketChannel::appendToBuffer(const char* data, int len)
232 {
233     char* newBuffer = 0;
234     if (tryFastMalloc(m_bufferSize + len).getValue(newBuffer)) {
235         if (m_buffer)
236             memcpy(newBuffer, m_buffer, m_bufferSize);
237         memcpy(newBuffer + m_bufferSize, data, len);
238         fastFree(m_buffer);
239         m_buffer = newBuffer;
240         m_bufferSize += len;
241         return true;
242     }
243     LOG(Network, "Too long WebSocket frame %d", m_bufferSize + len);
244     return false;
245 }
246
247 void WebSocketChannel::skipBuffer(int len)
248 {
249     ASSERT(len <= m_bufferSize);
250     m_bufferSize -= len;
251     if (!m_bufferSize) {
252         fastFree(m_buffer);
253         m_buffer = 0;
254         return;
255     }
256     memmove(m_buffer, m_buffer + len, m_bufferSize);
257 }
258
259 }  // namespace WebCore
260
261 #endif  // ENABLE(WEB_SOCKETS)