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