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