476c292da84dde292c74539733574b2571378bd6
[WebKit-https.git] / Source / WebCore / Modules / websockets / WebSocketChannel.cpp
1 /*
2  * Copyright (C) 2011, 2012 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 "Blob.h"
38 #include "CookieJar.h"
39 #include "Document.h"
40 #include "ExceptionCodePlaceholder.h"
41 #include "FileError.h"
42 #include "FileReaderLoader.h"
43 #include "Frame.h"
44 #include "FrameLoader.h"
45 #include "FrameLoaderClient.h"
46 #include "InspectorInstrumentation.h"
47 #include "Logging.h"
48 #include "Page.h"
49 #include "ProgressTracker.h"
50 #include "ScriptCallStack.h"
51 #include "ScriptExecutionContext.h"
52 #include "Settings.h"
53 #include "SocketStreamError.h"
54 #include "SocketStreamHandle.h"
55 #include "WebSocketChannelClient.h"
56 #include "WebSocketHandshake.h"
57
58 #include <wtf/ArrayBuffer.h>
59 #include <wtf/Deque.h>
60 #include <wtf/FastMalloc.h>
61 #include <wtf/HashMap.h>
62 #include <wtf/OwnPtr.h>
63 #include <wtf/PassOwnPtr.h>
64 #include <wtf/text/CString.h>
65 #include <wtf/text/StringHash.h>
66 #include <wtf/text/WTFString.h>
67
68 using namespace std;
69
70 namespace WebCore {
71
72 const double TCPMaximumSegmentLifetime = 2 * 60.0;
73
74 WebSocketChannel::WebSocketChannel(Document* document, WebSocketChannelClient* client)
75     : m_document(document)
76     , m_client(client)
77     , m_resumeTimer(this, &WebSocketChannel::resumeTimerFired)
78     , m_suspended(false)
79     , m_closing(false)
80     , m_receivedClosingHandshake(false)
81     , m_closingTimer(this, &WebSocketChannel::closingTimerFired)
82     , m_closed(false)
83     , m_shouldDiscardReceivedData(false)
84     , m_unhandledBufferedAmount(0)
85     , m_identifier(0)
86     , m_hasContinuousFrame(false)
87     , m_closeEventCode(CloseEventCodeAbnormalClosure)
88     , m_outgoingFrameQueueStatus(OutgoingFrameQueueOpen)
89 #if ENABLE(BLOB)
90     , m_blobLoaderStatus(BlobLoaderNotStarted)
91 #endif
92 {
93     if (Page* page = m_document->page())
94         m_identifier = page->progress()->createUniqueIdentifier();
95 }
96
97 WebSocketChannel::~WebSocketChannel()
98 {
99 }
100
101 void WebSocketChannel::connect(const KURL& url, const String& protocol)
102 {
103     LOG(Network, "WebSocketChannel %p connect", this);
104     ASSERT(!m_handle);
105     ASSERT(!m_suspended);
106     m_handshake = adoptPtr(new WebSocketHandshake(url, protocol, m_document));
107     m_handshake->reset();
108     if (m_deflateFramer.canDeflate())
109         m_handshake->addExtensionProcessor(m_deflateFramer.createExtensionProcessor());
110     if (m_identifier)
111         InspectorInstrumentation::didCreateWebSocket(m_document, m_identifier, url, m_document->url());
112     ref();
113     m_handle = SocketStreamHandle::create(m_handshake->url(), this);
114 }
115
116 String WebSocketChannel::subprotocol()
117 {
118     LOG(Network, "WebSocketChannel %p subprotocol", this);
119     if (!m_handshake || m_handshake->mode() != WebSocketHandshake::Connected)
120         return "";
121     String serverProtocol = m_handshake->serverWebSocketProtocol();
122     if (serverProtocol.isNull())
123         return "";
124     return serverProtocol;
125 }
126
127 String WebSocketChannel::extensions()
128 {
129     LOG(Network, "WebSocketChannel %p extensions", this);
130     if (!m_handshake || m_handshake->mode() != WebSocketHandshake::Connected)
131         return "";
132     String extensions = m_handshake->acceptedExtensions();
133     if (extensions.isNull())
134         return "";
135     return extensions;
136 }
137
138 ThreadableWebSocketChannel::SendResult WebSocketChannel::send(const String& message)
139 {
140     LOG(Network, "WebSocketChannel %p send %s", this, message.utf8().data());
141     CString utf8 = message.utf8(String::StrictConversionReplacingUnpairedSurrogatesWithFFFD);
142     enqueueTextFrame(utf8);
143     // According to WebSocket API specification, WebSocket.send() should return void instead
144     // of boolean. However, our implementation still returns boolean due to compatibility
145     // concern (see bug 65850).
146     // m_channel->send() may happen later, thus it's not always possible to know whether
147     // the message has been sent to the socket successfully. In this case, we have no choice
148     // but to return true.
149     return ThreadableWebSocketChannel::SendSuccess;
150 }
151
152 ThreadableWebSocketChannel::SendResult WebSocketChannel::send(const ArrayBuffer& binaryData, unsigned byteOffset, unsigned byteLength)
153 {
154     LOG(Network, "WebSocketChannel %p send arraybuffer %p %u %u", this, &binaryData, byteOffset, byteLength);
155     enqueueRawFrame(WebSocketFrame::OpCodeBinary, static_cast<const char*>(binaryData.data()) + byteOffset, byteLength);
156     return ThreadableWebSocketChannel::SendSuccess;
157 }
158
159 ThreadableWebSocketChannel::SendResult WebSocketChannel::send(const Blob& binaryData)
160 {
161     LOG(Network, "WebSocketChannel %p send blob %s", this, binaryData.url().string().utf8().data());
162     enqueueBlobFrame(WebSocketFrame::OpCodeBinary, binaryData);
163     return ThreadableWebSocketChannel::SendSuccess;
164 }
165
166 bool WebSocketChannel::send(const char* data, int length)
167 {
168     LOG(Network, "WebSocketChannel %p send binary %p (%dB)", this, data, length);
169     enqueueRawFrame(WebSocketFrame::OpCodeBinary, data, length);
170     return true;
171 }
172
173 unsigned long WebSocketChannel::bufferedAmount() const
174 {
175     LOG(Network, "WebSocketChannel %p bufferedAmount", this);
176     ASSERT(m_handle);
177     ASSERT(!m_suspended);
178     return m_handle->bufferedAmount();
179 }
180
181 void WebSocketChannel::close(int code, const String& reason)
182 {
183     LOG(Network, "WebSocketChannel %p close", this);
184     ASSERT(!m_suspended);
185     if (!m_handle)
186         return;
187     startClosingHandshake(code, reason);
188     if (m_closing && !m_closingTimer.isActive())
189         m_closingTimer.startOneShot(2 * TCPMaximumSegmentLifetime);
190 }
191
192 void WebSocketChannel::fail(const String& reason)
193 {
194     LOG(Network, "WebSocketChannel %p fail: %s", this, reason.utf8().data());
195     ASSERT(!m_suspended);
196     if (m_document) {
197         InspectorInstrumentation::didReceiveWebSocketFrameError(m_document, m_identifier, reason);
198         m_document->addConsoleMessage(JSMessageSource, ErrorMessageLevel, "WebSocket connection to '" + m_handshake->url().string() + "' failed: " + reason);
199     }
200
201     // Hybi-10 specification explicitly states we must not continue to handle incoming data
202     // once the WebSocket connection is failed (section 7.1.7).
203     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
204     m_shouldDiscardReceivedData = true;
205     if (!m_buffer.isEmpty())
206         skipBuffer(m_buffer.size()); // Save memory.
207     m_deflateFramer.didFail();
208     m_hasContinuousFrame = false;
209     m_continuousFrameData.clear();
210     m_client->didReceiveMessageError();
211
212     if (m_handle && !m_closed)
213         m_handle->disconnect(); // Will call didClose().
214 }
215
216 void WebSocketChannel::disconnect()
217 {
218     LOG(Network, "WebSocketChannel %p disconnect", this);
219     if (m_identifier && m_document)
220         InspectorInstrumentation::didCloseWebSocket(m_document, m_identifier);
221     if (m_handshake)
222         m_handshake->clearScriptExecutionContext();
223     m_client = 0;
224     m_document = 0;
225     if (m_handle)
226         m_handle->disconnect();
227 }
228
229 void WebSocketChannel::suspend()
230 {
231     m_suspended = true;
232 }
233
234 void WebSocketChannel::resume()
235 {
236     m_suspended = false;
237     if ((!m_buffer.isEmpty() || m_closed) && m_client && !m_resumeTimer.isActive())
238         m_resumeTimer.startOneShot(0);
239 }
240
241 void WebSocketChannel::willOpenSocketStream(SocketStreamHandle* handle)
242 {
243     LOG(Network, "WebSocketChannel %p willOpensocketStream", this);
244     ASSERT(handle);
245     if (m_document->frame())
246         m_document->frame()->loader()->client()->dispatchWillOpenSocketStream(handle);
247 }
248
249 void WebSocketChannel::didOpenSocketStream(SocketStreamHandle* handle)
250 {
251     LOG(Network, "WebSocketChannel %p didOpenSocketStream", this);
252     ASSERT(handle == m_handle);
253     if (!m_document)
254         return;
255     if (m_identifier)
256         InspectorInstrumentation::willSendWebSocketHandshakeRequest(m_document, m_identifier, *m_handshake->clientHandshakeRequest());
257     CString handshakeMessage = m_handshake->clientHandshakeMessage();
258     if (!handle->send(handshakeMessage.data(), handshakeMessage.length()))
259         fail("Failed to send WebSocket handshake.");
260 }
261
262 void WebSocketChannel::didCloseSocketStream(SocketStreamHandle* handle)
263 {
264     LOG(Network, "WebSocketChannel %p didCloseSocketStream", this);
265     if (m_identifier && m_document)
266         InspectorInstrumentation::didCloseWebSocket(m_document, m_identifier);
267     ASSERT_UNUSED(handle, handle == m_handle || !m_handle);
268     m_closed = true;
269     if (m_closingTimer.isActive())
270         m_closingTimer.stop();
271     if (m_outgoingFrameQueueStatus != OutgoingFrameQueueClosed)
272         abortOutgoingFrameQueue();
273     if (m_handle) {
274         m_unhandledBufferedAmount = m_handle->bufferedAmount();
275         if (m_suspended)
276             return;
277         WebSocketChannelClient* client = m_client;
278         m_client = 0;
279         m_document = 0;
280         m_handle = 0;
281         if (client)
282             client->didClose(m_unhandledBufferedAmount, m_receivedClosingHandshake ? WebSocketChannelClient::ClosingHandshakeComplete : WebSocketChannelClient::ClosingHandshakeIncomplete, m_closeEventCode, m_closeEventReason);
283     }
284     deref();
285 }
286
287 void WebSocketChannel::didReceiveSocketStreamData(SocketStreamHandle* handle, const char* data, int len)
288 {
289     LOG(Network, "WebSocketChannel %p didReceiveSocketStreamData %d", this, len);
290     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
291     ASSERT(handle == m_handle);
292     if (!m_document) {
293         return;
294     }
295     if (len <= 0) {
296         handle->disconnect();
297         return;
298     }
299     if (!m_client) {
300         m_shouldDiscardReceivedData = true;
301         handle->disconnect();
302         return;
303     }
304     if (m_shouldDiscardReceivedData)
305         return;
306     if (!appendToBuffer(data, len)) {
307         m_shouldDiscardReceivedData = true;
308         fail("Ran out of memory while receiving WebSocket data.");
309         return;
310     }
311     while (!m_suspended && m_client && !m_buffer.isEmpty())
312         if (!processBuffer())
313             break;
314 }
315
316 void WebSocketChannel::didUpdateBufferedAmount(SocketStreamHandle*, size_t bufferedAmount)
317 {
318     if (m_client)
319         m_client->didUpdateBufferedAmount(bufferedAmount);
320 }
321
322 void WebSocketChannel::didFailSocketStream(SocketStreamHandle* handle, const SocketStreamError& error)
323 {
324     LOG(Network, "WebSocketChannel %p didFailSocketStream", this);
325     ASSERT(handle == m_handle || !m_handle);
326     if (m_document) {
327         String message;
328         if (error.isNull())
329             message = "WebSocket network error";
330         else if (error.localizedDescription().isNull())
331             message = "WebSocket network error: error code " + String::number(error.errorCode());
332         else
333             message = "WebSocket network error: " + error.localizedDescription();
334         InspectorInstrumentation::didReceiveWebSocketFrameError(m_document, m_identifier, message);
335         m_document->addConsoleMessage(NetworkMessageSource, ErrorMessageLevel, message);
336     }
337     m_shouldDiscardReceivedData = true;
338     handle->disconnect();
339 }
340
341 void WebSocketChannel::didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
342 {
343 }
344
345 void WebSocketChannel::didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
346 {
347 }
348
349 #if ENABLE(BLOB)
350 void WebSocketChannel::didStartLoading()
351 {
352     LOG(Network, "WebSocketChannel %p didStartLoading", this);
353     ASSERT(m_blobLoader);
354     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
355 }
356
357 void WebSocketChannel::didReceiveData()
358 {
359     LOG(Network, "WebSocketChannel %p didReceiveData", this);
360     ASSERT(m_blobLoader);
361     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
362 }
363
364 void WebSocketChannel::didFinishLoading()
365 {
366     LOG(Network, "WebSocketChannel %p didFinishLoading", this);
367     ASSERT(m_blobLoader);
368     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
369     m_blobLoaderStatus = BlobLoaderFinished;
370     processOutgoingFrameQueue();
371     deref();
372 }
373
374 void WebSocketChannel::didFail(int errorCode)
375 {
376     LOG(Network, "WebSocketChannel %p didFail %d", this, errorCode);
377     ASSERT(m_blobLoader);
378     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
379     m_blobLoader.clear();
380     m_blobLoaderStatus = BlobLoaderFailed;
381     fail("Failed to load Blob: error code = " + String::number(errorCode)); // FIXME: Generate human-friendly reason message.
382     deref();
383 }
384 #endif
385
386 bool WebSocketChannel::appendToBuffer(const char* data, size_t len)
387 {
388     size_t newBufferSize = m_buffer.size() + len;
389     if (newBufferSize < m_buffer.size()) {
390         LOG(Network, "WebSocket buffer overflow (%lu+%lu)", static_cast<unsigned long>(m_buffer.size()), static_cast<unsigned long>(len));
391         return false;
392     }
393     m_buffer.append(data, len);
394     return true;
395 }
396
397 void WebSocketChannel::skipBuffer(size_t len)
398 {
399     ASSERT(len <= m_buffer.size());
400     memmove(m_buffer.data(), m_buffer.data() + len, m_buffer.size() - len);
401     m_buffer.resize(m_buffer.size() - len);
402 }
403
404 bool WebSocketChannel::processBuffer()
405 {
406     ASSERT(!m_suspended);
407     ASSERT(m_client);
408     ASSERT(!m_buffer.isEmpty());
409     LOG(Network, "WebSocketChannel %p processBuffer %lu", this, static_cast<unsigned long>(m_buffer.size()));
410
411     if (m_shouldDiscardReceivedData)
412         return false;
413
414     if (m_receivedClosingHandshake) {
415         skipBuffer(m_buffer.size());
416         return false;
417     }
418
419     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
420
421     if (m_handshake->mode() == WebSocketHandshake::Incomplete) {
422         int headerLength = m_handshake->readServerHandshake(m_buffer.data(), m_buffer.size());
423         if (headerLength <= 0)
424             return false;
425         if (m_handshake->mode() == WebSocketHandshake::Connected) {
426             if (m_identifier)
427                 InspectorInstrumentation::didReceiveWebSocketHandshakeResponse(m_document, m_identifier, m_handshake->serverHandshakeResponse());
428             if (!m_handshake->serverSetCookie().isEmpty()) {
429                 if (cookiesEnabled(m_document)) {
430                     // Exception (for sandboxed documents) ignored.
431                     m_document->setCookie(m_handshake->serverSetCookie(), IGNORE_EXCEPTION);
432                 }
433             }
434             // FIXME: handle set-cookie2.
435             LOG(Network, "WebSocketChannel %p connected", this);
436             skipBuffer(headerLength);
437             m_client->didConnect();
438             LOG(Network, "remaining in read buf %lu", static_cast<unsigned long>(m_buffer.size()));
439             return !m_buffer.isEmpty();
440         }
441         ASSERT(m_handshake->mode() == WebSocketHandshake::Failed);
442         LOG(Network, "WebSocketChannel %p connection failed", this);
443         skipBuffer(headerLength);
444         m_shouldDiscardReceivedData = true;
445         fail(m_handshake->failureReason());
446         return false;
447     }
448     if (m_handshake->mode() != WebSocketHandshake::Connected)
449         return false;
450
451     return processFrame();
452 }
453
454 void WebSocketChannel::resumeTimerFired(Timer<WebSocketChannel>* timer)
455 {
456     ASSERT_UNUSED(timer, timer == &m_resumeTimer);
457
458     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
459     while (!m_suspended && m_client && !m_buffer.isEmpty())
460         if (!processBuffer())
461             break;
462     if (!m_suspended && m_client && m_closed && m_handle)
463         didCloseSocketStream(m_handle.get());
464 }
465
466 void WebSocketChannel::startClosingHandshake(int code, const String& reason)
467 {
468     LOG(Network, "WebSocketChannel %p closing %d %d", this, m_closing, m_receivedClosingHandshake);
469     if (m_closing)
470         return;
471     ASSERT(m_handle);
472
473     Vector<char> buf;
474     if (!m_receivedClosingHandshake && code != CloseEventCodeNotSpecified) {
475         unsigned char highByte = code >> 8;
476         unsigned char lowByte = code;
477         buf.append(static_cast<char>(highByte));
478         buf.append(static_cast<char>(lowByte));
479         buf.append(reason.utf8().data(), reason.utf8().length());
480     }
481     enqueueRawFrame(WebSocketFrame::OpCodeClose, buf.data(), buf.size());
482
483     m_closing = true;
484     if (m_client)
485         m_client->didStartClosingHandshake();
486 }
487
488 void WebSocketChannel::closingTimerFired(Timer<WebSocketChannel>* timer)
489 {
490     LOG(Network, "WebSocketChannel %p closing timer", this);
491     ASSERT_UNUSED(timer, &m_closingTimer == timer);
492     if (m_handle)
493         m_handle->disconnect();
494 }
495
496
497 bool WebSocketChannel::processFrame()
498 {
499     ASSERT(!m_buffer.isEmpty());
500
501     WebSocketFrame frame;
502     const char* frameEnd;
503     String errorString;
504     WebSocketFrame::ParseFrameResult result = WebSocketFrame::parseFrame(m_buffer.data(), m_buffer.size(), frame, frameEnd, errorString);
505     if (result == WebSocketFrame::FrameIncomplete)
506         return false;
507     if (result == WebSocketFrame::FrameError) {
508         fail(errorString);
509         return false;
510     }
511
512     ASSERT(m_buffer.data() < frameEnd);
513     ASSERT(frameEnd <= m_buffer.data() + m_buffer.size());
514
515     OwnPtr<InflateResultHolder> inflateResult = m_deflateFramer.inflate(frame);
516     if (!inflateResult->succeeded()) {
517         fail(inflateResult->failureReason());
518         return false;
519     }
520
521     // Validate the frame data.
522     if (WebSocketFrame::isReservedOpCode(frame.opCode)) {
523         fail("Unrecognized frame opcode: " + String::number(frame.opCode));
524         return false;
525     }
526
527     if (frame.reserved2 || frame.reserved3) {
528         fail("One or more reserved bits are on: reserved2 = " + String::number(frame.reserved2) + ", reserved3 = " + String::number(frame.reserved3));
529         return false;
530     }
531
532     if (frame.masked) {
533         fail("A server must not mask any frames that it sends to the client.");
534         return false;
535     }
536
537     // All control frames must not be fragmented.
538     if (WebSocketFrame::isControlOpCode(frame.opCode) && !frame.final) {
539         fail("Received fragmented control frame: opcode = " + String::number(frame.opCode));
540         return false;
541     }
542
543     // All control frames must have a payload of 125 bytes or less, which means the frame must not contain
544     // the "extended payload length" field.
545     if (WebSocketFrame::isControlOpCode(frame.opCode) && WebSocketFrame::needsExtendedLengthField(frame.payloadLength)) {
546         fail("Received control frame having too long payload: " + String::number(frame.payloadLength) + " bytes");
547         return false;
548     }
549
550     // A new data frame is received before the previous continuous frame finishes.
551     // Note that control frames are allowed to come in the middle of continuous frames.
552     if (m_hasContinuousFrame && frame.opCode != WebSocketFrame::OpCodeContinuation && !WebSocketFrame::isControlOpCode(frame.opCode)) {
553         fail("Received new data frame but previous continuous frame is unfinished.");
554         return false;
555     }
556
557     InspectorInstrumentation::didReceiveWebSocketFrame(m_document, m_identifier, frame);
558
559     switch (frame.opCode) {
560     case WebSocketFrame::OpCodeContinuation:
561         // An unexpected continuation frame is received without any leading frame.
562         if (!m_hasContinuousFrame) {
563             fail("Received unexpected continuation frame.");
564             return false;
565         }
566         m_continuousFrameData.append(frame.payload, frame.payloadLength);
567         skipBuffer(frameEnd - m_buffer.data());
568         if (frame.final) {
569             // onmessage handler may eventually call the other methods of this channel,
570             // so we should pretend that we have finished to read this frame and
571             // make sure that the member variables are in a consistent state before
572             // the handler is invoked.
573             // Vector<char>::swap() is used here to clear m_continuousFrameData.
574             OwnPtr<Vector<char> > continuousFrameData = adoptPtr(new Vector<char>);
575             m_continuousFrameData.swap(*continuousFrameData);
576             m_hasContinuousFrame = false;
577             if (m_continuousFrameOpCode == WebSocketFrame::OpCodeText) {
578                 String message;
579                 if (continuousFrameData->size())
580                     message = String::fromUTF8(continuousFrameData->data(), continuousFrameData->size());
581                 else
582                     message = "";
583                 if (message.isNull())
584                     fail("Could not decode a text frame as UTF-8.");
585                 else
586                     m_client->didReceiveMessage(message);
587             } else if (m_continuousFrameOpCode == WebSocketFrame::OpCodeBinary)
588                 m_client->didReceiveBinaryData(continuousFrameData.release());
589         }
590         break;
591
592     case WebSocketFrame::OpCodeText:
593         if (frame.final) {
594             String message;
595             if (frame.payloadLength)
596                 message = String::fromUTF8(frame.payload, frame.payloadLength);
597             else
598                 message = "";
599             skipBuffer(frameEnd - m_buffer.data());
600             if (message.isNull())
601                 fail("Could not decode a text frame as UTF-8.");
602             else
603                 m_client->didReceiveMessage(message);
604         } else {
605             m_hasContinuousFrame = true;
606             m_continuousFrameOpCode = WebSocketFrame::OpCodeText;
607             ASSERT(m_continuousFrameData.isEmpty());
608             m_continuousFrameData.append(frame.payload, frame.payloadLength);
609             skipBuffer(frameEnd - m_buffer.data());
610         }
611         break;
612
613     case WebSocketFrame::OpCodeBinary:
614         if (frame.final) {
615             OwnPtr<Vector<char> > binaryData = adoptPtr(new Vector<char>(frame.payloadLength));
616             memcpy(binaryData->data(), frame.payload, frame.payloadLength);
617             skipBuffer(frameEnd - m_buffer.data());
618             m_client->didReceiveBinaryData(binaryData.release());
619         } else {
620             m_hasContinuousFrame = true;
621             m_continuousFrameOpCode = WebSocketFrame::OpCodeBinary;
622             ASSERT(m_continuousFrameData.isEmpty());
623             m_continuousFrameData.append(frame.payload, frame.payloadLength);
624             skipBuffer(frameEnd - m_buffer.data());
625         }
626         break;
627
628     case WebSocketFrame::OpCodeClose:
629         if (!frame.payloadLength)
630             m_closeEventCode = CloseEventCodeNoStatusRcvd;
631         else if (frame.payloadLength == 1) {
632             m_closeEventCode = CloseEventCodeAbnormalClosure;
633             fail("Received a broken close frame containing an invalid size body.");
634             return false;
635         } else {
636             unsigned char highByte = static_cast<unsigned char>(frame.payload[0]);
637             unsigned char lowByte = static_cast<unsigned char>(frame.payload[1]);
638             m_closeEventCode = highByte << 8 | lowByte;
639             if (m_closeEventCode == CloseEventCodeNoStatusRcvd || m_closeEventCode == CloseEventCodeAbnormalClosure || m_closeEventCode == CloseEventCodeTLSHandshake) {
640                 m_closeEventCode = CloseEventCodeAbnormalClosure;
641                 fail("Received a broken close frame containing a reserved status code.");
642                 return false;
643             }
644         }
645         if (frame.payloadLength >= 3)
646             m_closeEventReason = String::fromUTF8(&frame.payload[2], frame.payloadLength - 2);
647         else
648             m_closeEventReason = "";
649         skipBuffer(frameEnd - m_buffer.data());
650         m_receivedClosingHandshake = true;
651         startClosingHandshake(m_closeEventCode, m_closeEventReason);
652         if (m_closing) {
653             m_outgoingFrameQueueStatus = OutgoingFrameQueueClosing;
654             processOutgoingFrameQueue();
655         }
656         break;
657
658     case WebSocketFrame::OpCodePing:
659         enqueueRawFrame(WebSocketFrame::OpCodePong, frame.payload, frame.payloadLength);
660         skipBuffer(frameEnd - m_buffer.data());
661         break;
662
663     case WebSocketFrame::OpCodePong:
664         // A server may send a pong in response to our ping, or an unsolicited pong which is not associated with
665         // any specific ping. Either way, there's nothing to do on receipt of pong.
666         skipBuffer(frameEnd - m_buffer.data());
667         break;
668
669     default:
670         ASSERT_NOT_REACHED();
671         skipBuffer(frameEnd - m_buffer.data());
672         break;
673     }
674
675     return !m_buffer.isEmpty();
676 }
677
678 void WebSocketChannel::enqueueTextFrame(const CString& string)
679 {
680     ASSERT(m_outgoingFrameQueueStatus == OutgoingFrameQueueOpen);
681     OwnPtr<QueuedFrame> frame = adoptPtr(new QueuedFrame);
682     frame->opCode = WebSocketFrame::OpCodeText;
683     frame->frameType = QueuedFrameTypeString;
684     frame->stringData = string;
685     m_outgoingFrameQueue.append(frame.release());
686     processOutgoingFrameQueue();
687 }
688
689 void WebSocketChannel::enqueueRawFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength)
690 {
691     ASSERT(m_outgoingFrameQueueStatus == OutgoingFrameQueueOpen);
692     OwnPtr<QueuedFrame> frame = adoptPtr(new QueuedFrame);
693     frame->opCode = opCode;
694     frame->frameType = QueuedFrameTypeVector;
695     frame->vectorData.resize(dataLength);
696     if (dataLength)
697         memcpy(frame->vectorData.data(), data, dataLength);
698     m_outgoingFrameQueue.append(frame.release());
699     processOutgoingFrameQueue();
700 }
701
702 void WebSocketChannel::enqueueBlobFrame(WebSocketFrame::OpCode opCode, const Blob& blob)
703 {
704     ASSERT(m_outgoingFrameQueueStatus == OutgoingFrameQueueOpen);
705     OwnPtr<QueuedFrame> frame = adoptPtr(new QueuedFrame);
706     frame->opCode = opCode;
707     frame->frameType = QueuedFrameTypeBlob;
708     frame->blobData = Blob::create(blob.url(), blob.type(), blob.size());
709     m_outgoingFrameQueue.append(frame.release());
710     processOutgoingFrameQueue();
711 }
712
713 void WebSocketChannel::processOutgoingFrameQueue()
714 {
715     if (m_outgoingFrameQueueStatus == OutgoingFrameQueueClosed)
716         return;
717
718     while (!m_outgoingFrameQueue.isEmpty()) {
719         OwnPtr<QueuedFrame> frame = m_outgoingFrameQueue.takeFirst();
720         switch (frame->frameType) {
721         case QueuedFrameTypeString: {
722             if (!sendFrame(frame->opCode, frame->stringData.data(), frame->stringData.length()))
723                 fail("Failed to send WebSocket frame.");
724             break;
725         }
726
727         case QueuedFrameTypeVector:
728             if (!sendFrame(frame->opCode, frame->vectorData.data(), frame->vectorData.size()))
729                 fail("Failed to send WebSocket frame.");
730             break;
731
732         case QueuedFrameTypeBlob: {
733 #if ENABLE(BLOB)
734             switch (m_blobLoaderStatus) {
735             case BlobLoaderNotStarted:
736                 ref(); // Will be derefed after didFinishLoading() or didFail().
737                 ASSERT(!m_blobLoader);
738                 m_blobLoader = adoptPtr(new FileReaderLoader(FileReaderLoader::ReadAsArrayBuffer, this));
739                 m_blobLoaderStatus = BlobLoaderStarted;
740                 m_blobLoader->start(m_document, frame->blobData.get());
741                 m_outgoingFrameQueue.prepend(frame.release());
742                 return;
743
744             case BlobLoaderStarted:
745             case BlobLoaderFailed:
746                 m_outgoingFrameQueue.prepend(frame.release());
747                 return;
748
749             case BlobLoaderFinished: {
750                 RefPtr<ArrayBuffer> result = m_blobLoader->arrayBufferResult();
751                 m_blobLoader.clear();
752                 m_blobLoaderStatus = BlobLoaderNotStarted;
753                 if (!sendFrame(frame->opCode, static_cast<const char*>(result->data()), result->byteLength()))
754                     fail("Failed to send WebSocket frame.");
755                 break;
756             }
757             }
758 #else
759             fail("FileReader is not available. Could not send a Blob as WebSocket binary message.");
760 #endif
761             break;
762         }
763
764         default:
765             ASSERT_NOT_REACHED();
766             break;
767         }
768     }
769
770     ASSERT(m_outgoingFrameQueue.isEmpty());
771     if (m_outgoingFrameQueueStatus == OutgoingFrameQueueClosing) {
772         m_outgoingFrameQueueStatus = OutgoingFrameQueueClosed;
773         m_handle->close();
774     }
775 }
776
777 void WebSocketChannel::abortOutgoingFrameQueue()
778 {
779     m_outgoingFrameQueue.clear();
780     m_outgoingFrameQueueStatus = OutgoingFrameQueueClosed;
781 #if ENABLE(BLOB)
782     if (m_blobLoaderStatus == BlobLoaderStarted) {
783         m_blobLoader->cancel();
784         didFail(FileError::ABORT_ERR);
785     }
786 #endif
787 }
788
789 bool WebSocketChannel::sendFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength)
790 {
791     ASSERT(m_handle);
792     ASSERT(!m_suspended);
793
794     WebSocketFrame frame(opCode, true, false, true, data, dataLength);
795     InspectorInstrumentation::didSendWebSocketFrame(m_document, m_identifier, frame);
796
797     OwnPtr<DeflateResultHolder> deflateResult = m_deflateFramer.deflate(frame);
798     if (!deflateResult->succeeded()) {
799         fail(deflateResult->failureReason());
800         return false;
801     }
802
803     Vector<char> frameData;
804     frame.makeFrameData(frameData);
805
806     return m_handle->send(frameData.data(), frameData.size());
807 }
808
809 }  // namespace WebCore
810
811 #endif  // ENABLE(WEB_SOCKETS)