31e470aa94e3bd7f7819c0ab96de5dadd46d78c9
[WebKit-https.git] / Source / WebCore / Modules / websockets / WebSocketChannel.h
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 #ifndef WebSocketChannel_h
32 #define WebSocketChannel_h
33
34 #if ENABLE(WEB_SOCKETS)
35
36 #include "FileReaderLoaderClient.h"
37 #include "SocketStreamHandleClient.h"
38 #include "ThreadableWebSocketChannel.h"
39 #include "Timer.h"
40 #include "WebSocketDeflateFramer.h"
41 #include "WebSocketFrame.h"
42 #include "WebSocketHandshake.h"
43 #include <wtf/Deque.h>
44 #include <wtf/Forward.h>
45 #include <wtf/RefCounted.h>
46 #include <wtf/Vector.h>
47 #include <wtf/text/CString.h>
48
49 namespace WebCore {
50
51 class Blob;
52 class Document;
53 class FileReaderLoader;
54 class SocketStreamHandle;
55 class SocketStreamError;
56 class WebSocketChannelClient;
57
58 class WebSocketChannel : public RefCounted<WebSocketChannel>, public SocketStreamHandleClient, public ThreadableWebSocketChannel
59 #if ENABLE(BLOB)
60                        , public FileReaderLoaderClient
61 #endif
62 {
63     WTF_MAKE_FAST_ALLOCATED;
64 public:
65     static PassRefPtr<WebSocketChannel> create(Document* document, WebSocketChannelClient* client) { return adoptRef(new WebSocketChannel(document, client)); }
66     virtual ~WebSocketChannel();
67
68     bool send(const char* data, int length);
69
70     // ThreadableWebSocketChannel functions.
71     virtual bool useHixie76Protocol() OVERRIDE;
72     virtual void connect(const KURL&, const String& protocol) OVERRIDE;
73     virtual String subprotocol() OVERRIDE;
74     virtual String extensions() OVERRIDE;
75     virtual ThreadableWebSocketChannel::SendResult send(const String& message) OVERRIDE;
76     virtual ThreadableWebSocketChannel::SendResult send(const ArrayBuffer&) OVERRIDE;
77     virtual ThreadableWebSocketChannel::SendResult send(const Blob&) OVERRIDE;
78     virtual unsigned long bufferedAmount() const OVERRIDE;
79     virtual void close(int code, const String& reason) OVERRIDE; // Start closing handshake.
80     virtual void fail(const String& reason) OVERRIDE;
81     virtual void disconnect() OVERRIDE;
82
83     virtual void suspend() OVERRIDE;
84     virtual void resume() OVERRIDE;
85
86     // SocketStreamHandleClient functions.
87     virtual void willOpenSocketStream(SocketStreamHandle*) OVERRIDE;
88     virtual void didOpenSocketStream(SocketStreamHandle*) OVERRIDE;
89     virtual void didCloseSocketStream(SocketStreamHandle*) OVERRIDE;
90     virtual void didReceiveSocketStreamData(SocketStreamHandle*, const char*, int) OVERRIDE;
91     virtual void didUpdateBufferedAmount(SocketStreamHandle*, size_t bufferedAmount) OVERRIDE;
92     virtual void didFailSocketStream(SocketStreamHandle*, const SocketStreamError&) OVERRIDE;
93     virtual void didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&) OVERRIDE;
94     virtual void didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&) OVERRIDE;
95
96     enum CloseEventCode {
97         CloseEventCodeNotSpecified = -1,
98         CloseEventCodeNormalClosure = 1000,
99         CloseEventCodeGoingAway = 1001,
100         CloseEventCodeProtocolError = 1002,
101         CloseEventCodeUnsupportedData = 1003,
102         CloseEventCodeFrameTooLarge = 1004,
103         CloseEventCodeNoStatusRcvd = 1005,
104         CloseEventCodeAbnormalClosure = 1006,
105         CloseEventCodeInvalidFramePayloadData = 1007,
106         CloseEventCodePolicyViolation = 1008,
107         CloseEventCodeMessageTooBig = 1009,
108         CloseEventCodeMandatoryExt = 1010,
109         CloseEventCodeInternalError = 1011,
110         CloseEventCodeTLSHandshake = 1015,
111         CloseEventCodeMinimumUserDefined = 3000,
112         CloseEventCodeMaximumUserDefined = 4999
113     };
114
115 #if ENABLE(BLOB)
116     // FileReaderLoaderClient functions.
117     virtual void didStartLoading();
118     virtual void didReceiveData();
119     virtual void didFinishLoading();
120     virtual void didFail(int errorCode);
121 #endif
122
123     using RefCounted<WebSocketChannel>::ref;
124     using RefCounted<WebSocketChannel>::deref;
125
126 protected:
127     virtual void refThreadableWebSocketChannel() { ref(); }
128     virtual void derefThreadableWebSocketChannel() { deref(); }
129
130 private:
131     WebSocketChannel(Document*, WebSocketChannelClient*);
132
133     bool appendToBuffer(const char* data, size_t len);
134     void skipBuffer(size_t len);
135     bool processBuffer();
136     void resumeTimerFired(Timer<WebSocketChannel>*);
137     void startClosingHandshake(int code, const String& reason);
138     void closingTimerFired(Timer<WebSocketChannel>*);
139
140     bool processFrame();
141     bool processFrameHixie76();
142
143     // It is allowed to send a Blob as a binary frame if hybi-10 protocol is in use. Sending a Blob
144     // can be delayed because it must be read asynchronously. Other types of data (String or
145     // ArrayBuffer) may also be blocked by preceding sending request of a Blob.
146     //
147     // To address this situation, messages to be sent need to be stored in a queue. Whenever a new
148     // data frame is going to be sent, it first must go to the queue. Items in the queue are processed
149     // in the order they were put into the queue. Sending request of a Blob blocks further processing
150     // until the Blob is completely read and sent to the socket stream.
151     //
152     // When hixie-76 protocol is chosen, the queue is not used and messages are sent directly.
153     enum QueuedFrameType {
154         QueuedFrameTypeString,
155         QueuedFrameTypeVector,
156         QueuedFrameTypeBlob
157     };
158     struct QueuedFrame {
159         WebSocketFrame::OpCode opCode;
160         QueuedFrameType frameType;
161         // Only one of the following items is used, according to the value of frameType.
162         CString stringData;
163         Vector<char> vectorData;
164         RefPtr<Blob> blobData;
165     };
166     void enqueueTextFrame(const CString&);
167     void enqueueRawFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
168     void enqueueBlobFrame(WebSocketFrame::OpCode, const Blob&);
169
170     void processOutgoingFrameQueue();
171     void abortOutgoingFrameQueue();
172
173     enum OutgoingFrameQueueStatus {
174         // It is allowed to put a new item into the queue.
175         OutgoingFrameQueueOpen,
176         // Close frame has already been put into the queue but may not have been sent yet;
177         // m_handle->close() will be called as soon as the queue is cleared. It is not
178         // allowed to put a new item into the queue.
179         OutgoingFrameQueueClosing,
180         // Close frame has been sent or the queue was aborted. It is not allowed to put
181         // a new item to the queue.
182         OutgoingFrameQueueClosed
183     };
184
185     // If you are going to send a hybi-10 frame, you need to use the outgoing frame queue
186     // instead of call sendFrame() directly.
187     bool sendFrame(WebSocketFrame::OpCode, const char* data, size_t dataLength);
188     bool sendFrameHixie76(const char* data, size_t dataLength);
189
190 #if ENABLE(BLOB)
191     enum BlobLoaderStatus {
192         BlobLoaderNotStarted,
193         BlobLoaderStarted,
194         BlobLoaderFinished,
195         BlobLoaderFailed
196     };
197 #endif
198
199     Document* m_document;
200     WebSocketChannelClient* m_client;
201     OwnPtr<WebSocketHandshake> m_handshake;
202     RefPtr<SocketStreamHandle> m_handle;
203     char* m_buffer;
204     size_t m_bufferSize;
205
206     Timer<WebSocketChannel> m_resumeTimer;
207     bool m_suspended;
208     bool m_closing;
209     bool m_receivedClosingHandshake;
210     Timer<WebSocketChannel> m_closingTimer;
211     bool m_closed;
212     bool m_shouldDiscardReceivedData;
213     unsigned long m_unhandledBufferedAmount;
214
215     unsigned long m_identifier; // m_identifier == 0 means that we could not obtain a valid identifier.
216
217     bool m_useHixie76Protocol;
218
219     // Private members only for hybi-10 protocol.
220     bool m_hasContinuousFrame;
221     WebSocketFrame::OpCode m_continuousFrameOpCode;
222     Vector<char> m_continuousFrameData;
223     unsigned short m_closeEventCode;
224     String m_closeEventReason;
225
226     Deque<OwnPtr<QueuedFrame> > m_outgoingFrameQueue;
227     OutgoingFrameQueueStatus m_outgoingFrameQueueStatus;
228
229 #if ENABLE(BLOB)
230     // FIXME: Load two or more Blobs simultaneously for better performance.
231     OwnPtr<FileReaderLoader> m_blobLoader;
232     BlobLoaderStatus m_blobLoaderStatus;
233 #endif
234
235     WebSocketDeflateFramer m_deflateFramer;
236 };
237
238 } // namespace WebCore
239
240 #endif // ENABLE(WEB_SOCKETS)
241
242 #endif // WebSocketChannel_h