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